diff --git a/.changeset/spotty-donuts-sleep.md b/.changeset/spotty-donuts-sleep.md new file mode 100644 index 000000000..bbad459b1 --- /dev/null +++ b/.changeset/spotty-donuts-sleep.md @@ -0,0 +1,5 @@ +--- +"openapi-typescript": minor +--- + +Don’t generate `| undefined` for additionalProperties diff --git a/docs/data/contributors.json b/docs/data/contributors.json index 4c053718a..9b5bbf21f 100644 --- a/docs/data/contributors.json +++ b/docs/data/contributors.json @@ -1 +1 @@ -{"openapi-typescript":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1718377279191},{"username":"psmyrdek","avatar":"https://avatars.githubusercontent.com/u/6187417?v=4?s=400","name":"Przemek Smyrdek","links":[{"icon":"github","link":"https://github.com/psmyrdek"}],"lastFetch":1718377280202},{"username":"enmand","avatar":"https://avatars.githubusercontent.com/u/432487?v=4?s=400","name":"Dan Enman","links":[{"icon":"github","link":"https://github.com/enmand"}],"lastFetch":1718377281178},{"username":"atlefren","avatar":"https://avatars.githubusercontent.com/u/1829927?v=4?s=400","name":"Atle Frenvik Sveen","links":[{"icon":"github","link":"https://github.com/atlefren"}],"lastFetch":1718377282171},{"username":"tpdewolf","avatar":"https://avatars.githubusercontent.com/u/4455209?v=4?s=400","name":"Tim de Wolf","links":[{"icon":"github","link":"https://github.com/tpdewolf"}],"lastFetch":1718377283235},{"username":"tombarton","avatar":"https://avatars.githubusercontent.com/u/6222711?v=4?s=400","name":"Tom Barton","links":[{"icon":"github","link":"https://github.com/tombarton"}],"lastFetch":1718377284245},{"username":"svnv","avatar":"https://avatars.githubusercontent.com/u/1080888?v=4?s=400","name":"Sven Nicolai Viig","links":[{"icon":"github","link":"https://github.com/svnv"}],"lastFetch":1718377285215},{"username":"sorin-davidoi","avatar":"https://avatars.githubusercontent.com/u/2109702?v=4?s=400","name":"Sorin Davidoi","links":[{"icon":"github","link":"https://github.com/sorin-davidoi"}],"lastFetch":1718377286224},{"username":"scvnathan","avatar":"https://avatars.githubusercontent.com/u/73474?v=4?s=400","name":"Nathan Schneirov","links":[{"icon":"github","link":"https://github.com/scvnathan"}],"lastFetch":1718377287271},{"username":"lbenie","avatar":"https://avatars.githubusercontent.com/u/7316046?v=4?s=400","name":"Lucien Bénié","links":[{"icon":"github","link":"https://github.com/lbenie"}],"lastFetch":1718377288325},{"username":"bokub","avatar":"https://avatars.githubusercontent.com/u/17952318?v=4?s=400","name":"Boris K","links":[{"icon":"github","link":"https://github.com/bokub"}],"lastFetch":1718377289363},{"username":"antonk52","avatar":"https://avatars.githubusercontent.com/u/5817809?v=4?s=400","name":"Anton Kastritskii","links":[{"icon":"github","link":"https://github.com/antonk52"}],"lastFetch":1718377290372},{"username":"tshelburne","avatar":"https://avatars.githubusercontent.com/u/1202267?v=4?s=400","name":"Tim Shelburne","links":[{"icon":"github","link":"https://github.com/tshelburne"}],"lastFetch":1718377291356},{"username":"typeofweb","avatar":"https://avatars.githubusercontent.com/u/1338731?v=4?s=400","name":"Michał Miszczyszyn","links":[{"icon":"github","link":"https://github.com/typeofweb"}],"lastFetch":1718377292349},{"username":"skh-","avatar":"https://avatars.githubusercontent.com/u/1292598?v=4?s=400","name":"Sam K Hall","links":[{"icon":"github","link":"https://github.com/skh-"}],"lastFetch":1718377293317},{"username":"BlooJeans","avatar":"https://avatars.githubusercontent.com/u/1751182?v=4?s=400","name":"Matt Jeanes","links":[{"icon":"github","link":"https://github.com/BlooJeans"}],"lastFetch":1718377389101},{"username":"selbekk","avatar":"https://avatars.githubusercontent.com/u/1307267?v=4?s=400","name":"Kristofer Giltvedt Selbekk","links":[{"icon":"github","link":"https://github.com/selbekk"}],"lastFetch":1718377390093},{"username":"Mause","avatar":"https://avatars.githubusercontent.com/u/1405026?v=4?s=400","name":"Elliana May","links":[{"icon":"github","link":"https://github.com/Mause"}],"lastFetch":1718377391179},{"username":"henhal","avatar":"https://avatars.githubusercontent.com/u/9608258?v=4?s=400","name":"Henrik Hall","links":[{"icon":"github","link":"https://github.com/henhal"}],"lastFetch":1718377392154},{"username":"gr2m","avatar":"https://avatars.githubusercontent.com/u/39992?v=4?s=400","name":"Gregor Martynus","links":[{"icon":"github","link":"https://github.com/gr2m"}],"lastFetch":1718377393596},{"username":"samdbmg","avatar":"https://avatars.githubusercontent.com/u/408983?v=4?s=400","name":"Sam Mesterton-Gibbons","links":[{"icon":"github","link":"https://github.com/samdbmg"}],"lastFetch":1718377394604},{"username":"rendall","avatar":"https://avatars.githubusercontent.com/u/293263?v=4?s=400","name":"Rendall","links":[{"icon":"github","link":"https://github.com/rendall"}],"lastFetch":1718377395615},{"username":"robertmassaioli","avatar":"https://avatars.githubusercontent.com/u/149178?v=4?s=400","name":"Robert Massaioli","links":[{"icon":"github","link":"https://github.com/robertmassaioli"}],"lastFetch":1718377396699},{"username":"jankuca","avatar":"https://avatars.githubusercontent.com/u/367262?v=4?s=400","name":"Jan Kuča","links":[{"icon":"github","link":"https://github.com/jankuca"}],"lastFetch":1718377397699},{"username":"th-m","avatar":"https://avatars.githubusercontent.com/u/13792029?v=4?s=400","name":"Thomas Valadez","links":[{"icon":"github","link":"https://github.com/th-m"}],"lastFetch":1718377398838},{"username":"asithade","avatar":"https://avatars.githubusercontent.com/u/3814354?v=4?s=400","name":"Asitha de Silva","links":[{"icon":"github","link":"https://github.com/asithade"}],"lastFetch":1718377399814},{"username":"misha-erm","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4?s=400","name":"Misha","links":[{"icon":"github","link":"https://github.com/misha-erm"}],"lastFetch":1718377400783},{"username":"radist2s","avatar":"https://avatars.githubusercontent.com/u/725645?v=4?s=400","name":"Alex Batalov","links":[{"icon":"github","link":"https://github.com/radist2s"}],"lastFetch":1718377401755},{"username":"FedeBev","avatar":"https://avatars.githubusercontent.com/u/22151395?v=4?s=400","name":"Federico Bevione","links":[{"icon":"github","link":"https://github.com/FedeBev"}],"lastFetch":1718377402740},{"username":"yamacent","avatar":"https://avatars.githubusercontent.com/u/8544439?v=4?s=400","name":"Daisuke Yamamoto","links":[{"icon":"github","link":"https://github.com/yamacent"}],"lastFetch":1718377403856},{"username":"dnalborczyk","avatar":"https://avatars.githubusercontent.com/u/2903325?v=4?s=400","name":"dnalborczyk","links":[{"icon":"github","link":"https://github.com/dnalborczyk"}],"lastFetch":1718377404824},{"username":"FabioWanner","avatar":"https://avatars.githubusercontent.com/u/46821078?v=4?s=400","name":"FabioWanner","links":[{"icon":"github","link":"https://github.com/FabioWanner"}],"lastFetch":1718377405811},{"username":"ashsmith","avatar":"https://avatars.githubusercontent.com/u/1086841?v=4?s=400","name":"Ash Smith","links":[{"icon":"github","link":"https://github.com/ashsmith"}],"lastFetch":1718377406820},{"username":"mehalter","avatar":"https://avatars.githubusercontent.com/u/1591837?v=4?s=400","name":"Micah Halter","links":[{"icon":"github","link":"https://github.com/mehalter"}],"lastFetch":1718377407953},{"username":"Chrg1001","avatar":"https://avatars.githubusercontent.com/u/40189653?v=4?s=400","name":"chrg1001","links":[{"icon":"github","link":"https://github.com/Chrg1001"}],"lastFetch":1718377409064},{"username":"sharmarajdaksh","avatar":"https://avatars.githubusercontent.com/u/33689528?v=4?s=400","name":"Dakshraj Sharma","links":[{"icon":"github","link":"https://github.com/sharmarajdaksh"}],"lastFetch":1718377420085},{"username":"shuluster","avatar":"https://avatars.githubusercontent.com/u/1707910?v=4?s=400","name":"Shaosu Liu","links":[{"icon":"github","link":"https://github.com/shuluster"}],"lastFetch":1718377421010},{"username":"FDiskas","avatar":"https://avatars.githubusercontent.com/u/468006?v=4?s=400","name":"Vytenis","links":[{"icon":"github","link":"https://github.com/FDiskas"}],"lastFetch":1718377422073},{"username":"ericzorn93","avatar":"https://avatars.githubusercontent.com/u/22532542?v=4?s=400","name":"Eric Zorn","links":[{"icon":"github","link":"https://github.com/ericzorn93"}],"lastFetch":1718377423213},{"username":"mbelsky","avatar":"https://avatars.githubusercontent.com/u/3923527?v=4?s=400","name":"Max Belsky","links":[{"icon":"github","link":"https://github.com/mbelsky"}],"lastFetch":1718377424200},{"username":"techbech","avatar":"https://avatars.githubusercontent.com/u/1520592?v=4?s=400","name":"Peter Bech","links":[{"icon":"github","link":"https://github.com/techbech"}],"lastFetch":1718377425184},{"username":"rustyconover","avatar":"https://avatars.githubusercontent.com/u/731941?v=4?s=400","name":"Rusty Conover","links":[{"icon":"github","link":"https://github.com/rustyconover"}],"lastFetch":1718377426167},{"username":"bunkscene","avatar":"https://avatars.githubusercontent.com/u/2693678?v=4?s=400","name":"Dave Carlson","links":[{"icon":"github","link":"https://github.com/bunkscene"}],"lastFetch":1718377427092},{"username":"ottomated","avatar":"https://avatars.githubusercontent.com/u/31470743?v=4?s=400","name":"ottomated","links":[{"icon":"github","link":"https://github.com/ottomated"}],"lastFetch":1718377428238},{"username":"sadfsdfdsa","avatar":"https://avatars.githubusercontent.com/u/28733669?v=4?s=400","name":"Artem Shuvaev","links":[{"icon":"github","link":"https://github.com/sadfsdfdsa"}],"lastFetch":1718377429460},{"username":"ajaishankar","avatar":"https://avatars.githubusercontent.com/u/328008?v=4?s=400","name":"ajaishankar","links":[{"icon":"github","link":"https://github.com/ajaishankar"}],"lastFetch":1718377430425},{"username":"dominikdosoudil","avatar":"https://avatars.githubusercontent.com/u/15929942?v=4?s=400","name":"Dominik Dosoudil","links":[{"icon":"github","link":"https://github.com/dominikdosoudil"}],"lastFetch":1718377431608},{"username":"kgtkr","avatar":"https://avatars.githubusercontent.com/u/17868838?v=4?s=400","name":"kgtkr","links":[{"icon":"github","link":"https://github.com/kgtkr"}],"lastFetch":1718377432735},{"username":"berzi","avatar":"https://avatars.githubusercontent.com/u/32619123?v=4?s=400","name":"berzi","links":[{"icon":"github","link":"https://github.com/berzi"}],"lastFetch":1718377433735},{"username":"PhilipTrauner","avatar":"https://avatars.githubusercontent.com/u/9287847?v=4?s=400","name":"Philip Trauner","links":[{"icon":"github","link":"https://github.com/PhilipTrauner"}],"lastFetch":1718377434759},{"username":"Powell-v2","avatar":"https://avatars.githubusercontent.com/u/25308326?v=4?s=400","name":"Pavel Yermolin","links":[{"icon":"github","link":"https://github.com/Powell-v2"}],"lastFetch":1718377435751},{"username":"duncanbeevers","avatar":"https://avatars.githubusercontent.com/u/7367?v=4?s=400","name":"Duncan Beevers","links":[{"icon":"github","link":"https://github.com/duncanbeevers"}],"lastFetch":1718377436830},{"username":"tkukushkin","avatar":"https://avatars.githubusercontent.com/u/1482516?v=4?s=400","name":"Timofei Kukushkin","links":[{"icon":"github","link":"https://github.com/tkukushkin"}],"lastFetch":1718377437958},{"username":"Semigradsky","avatar":"https://avatars.githubusercontent.com/u/1198848?v=4?s=400","name":"Dmitry Semigradsky","links":[{"icon":"github","link":"https://github.com/Semigradsky"}],"lastFetch":1718377439067},{"username":"MrLeebo","avatar":"https://avatars.githubusercontent.com/u/2754163?v=4?s=400","name":"Jeremy Liberman","links":[{"icon":"github","link":"https://github.com/MrLeebo"}],"lastFetch":1718377440207},{"username":"axelhzf","avatar":"https://avatars.githubusercontent.com/u/175627?v=4?s=400","name":"Axel Hernández Ferrera","links":[{"icon":"github","link":"https://github.com/axelhzf"}],"lastFetch":1718377441190},{"username":"imagoiq","avatar":"https://avatars.githubusercontent.com/u/12294151?v=4?s=400","name":"Loïc Fürhoff","links":[{"icon":"github","link":"https://github.com/imagoiq"}],"lastFetch":1718377442189},{"username":"BTMPL","avatar":"https://avatars.githubusercontent.com/u/247153?v=4?s=400","name":"Bartosz Szczeciński","links":[{"icon":"github","link":"https://github.com/BTMPL"}],"lastFetch":1718377443180},{"username":"HiiiiD","avatar":"https://avatars.githubusercontent.com/u/61231210?v=4?s=400","name":"Marco Salomone","links":[{"icon":"github","link":"https://github.com/HiiiiD"}],"lastFetch":1718377444162},{"username":"yacinehmito","avatar":"https://avatars.githubusercontent.com/u/6893840?v=4?s=400","name":"Yacine Hmito","links":[{"icon":"github","link":"https://github.com/yacinehmito"}],"lastFetch":1718377445178},{"username":"sajadtorkamani","avatar":"https://avatars.githubusercontent.com/u/9380313?v=4?s=400","name":"Sajad Torkamani","links":[{"icon":"github","link":"https://github.com/sajadtorkamani"}],"lastFetch":1718377446179},{"username":"mvdbeek","avatar":"https://avatars.githubusercontent.com/u/6804901?v=4?s=400","name":"Marius van den Beek","links":[{"icon":"github","link":"https://github.com/mvdbeek"}],"lastFetch":1718377447191},{"username":"sgrimm","avatar":"https://avatars.githubusercontent.com/u/1248649?v=4?s=400","name":"Steven Grimm","links":[{"icon":"github","link":"https://github.com/sgrimm"}],"lastFetch":1718377448152},{"username":"Swiftwork","avatar":"https://avatars.githubusercontent.com/u/455178?v=4?s=400","name":"Erik Hughes","links":[{"icon":"github","link":"https://github.com/Swiftwork"}],"lastFetch":1718377449408},{"username":"mtth","avatar":"https://avatars.githubusercontent.com/u/1216372?v=4?s=400","name":"Matthieu Monsch","links":[{"icon":"github","link":"https://github.com/mtth"}],"lastFetch":1718377450364},{"username":"mitchell-merry","avatar":"https://avatars.githubusercontent.com/u/8567231?v=4?s=400","name":"Mitchell Merry","links":[{"icon":"github","link":"https://github.com/mitchell-merry"}],"lastFetch":1718377451349},{"username":"qnp","avatar":"https://avatars.githubusercontent.com/u/6012554?v=4?s=400","name":"François Risoud","links":[{"icon":"github","link":"https://github.com/qnp"}],"lastFetch":1718377452325},{"username":"shoffmeister","avatar":"https://avatars.githubusercontent.com/u/3868036?v=4?s=400","name":"shoffmeister","links":[{"icon":"github","link":"https://github.com/shoffmeister"}],"lastFetch":1718377453398},{"username":"liangskyli","avatar":"https://avatars.githubusercontent.com/u/31531283?v=4?s=400","name":"liangsky","links":[{"icon":"github","link":"https://github.com/liangskyli"}],"lastFetch":1718377454346},{"username":"happycollision","avatar":"https://avatars.githubusercontent.com/u/3663628?v=4?s=400","name":"Don Denton","links":[{"icon":"github","link":"https://github.com/happycollision"}],"lastFetch":1718377455331},{"username":"ysmood","avatar":"https://avatars.githubusercontent.com/u/1415488?v=4?s=400","name":"Yad Smood","links":[{"icon":"github","link":"https://github.com/ysmood"}],"lastFetch":1718377456332},{"username":"barakalon","avatar":"https://avatars.githubusercontent.com/u/12398927?v=4?s=400","name":"barak","links":[{"icon":"github","link":"https://github.com/barakalon"}],"lastFetch":1718377457324},{"username":"horaklukas","avatar":"https://avatars.githubusercontent.com/u/996088?v=4?s=400","name":"Lukáš Horák","links":[{"icon":"github","link":"https://github.com/horaklukas"}],"lastFetch":1718377458301},{"username":"pvanagtmaal","avatar":"https://avatars.githubusercontent.com/u/5946464?v=4?s=400","name":"pvanagtmaal","links":[{"icon":"github","link":"https://github.com/pvanagtmaal"}],"lastFetch":1718377459273},{"username":"toomuchdesign","avatar":"https://avatars.githubusercontent.com/u/4573549?v=4?s=400","name":"Andrea Carraro","links":[{"icon":"github","link":"https://github.com/toomuchdesign"}],"lastFetch":1718377460287},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1718377461280},{"username":"tkrotoff","avatar":"https://avatars.githubusercontent.com/u/643434?v=4?s=400","name":"Tanguy Krotoff","links":[{"icon":"github","link":"https://github.com/tkrotoff"}],"lastFetch":1718377462265},{"username":"pimveldhuisen","avatar":"https://avatars.githubusercontent.com/u/3043834?v=4?s=400","name":"Pim Veldhuisen","links":[{"icon":"github","link":"https://github.com/pimveldhuisen"}],"lastFetch":1718377463252},{"username":"asvishnyakov","avatar":"https://avatars.githubusercontent.com/u/6369252?v=4?s=400","name":"Aleksandr Vishniakov","links":[{"icon":"github","link":"https://github.com/asvishnyakov"}],"lastFetch":1718377464218},{"username":"SchabaJo","avatar":"https://avatars.githubusercontent.com/u/138689813?v=4?s=400","name":"SchabaJo","links":[{"icon":"github","link":"https://github.com/SchabaJo"}],"lastFetch":1718377465184},{"username":"AhsanFazal","avatar":"https://avatars.githubusercontent.com/u/7458046?v=4?s=400","name":"Ahsan Fazal","links":[{"icon":"github","link":"https://github.com/AhsanFazal"}],"lastFetch":1718377466398},{"username":"ElForastero","avatar":"https://avatars.githubusercontent.com/u/5102818?v=4?s=400","name":"Eugene Dzhumak","links":[{"icon":"github","link":"https://github.com/ElForastero"}],"lastFetch":1718377467527},{"username":"msgadi","avatar":"https://avatars.githubusercontent.com/u/9037086?v=4?s=400","name":"Mohammed Gadi","links":[{"icon":"github","link":"https://github.com/msgadi"}],"lastFetch":1718377468659},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1718377469604},{"username":"christoph-fricke","avatar":"https://avatars.githubusercontent.com/u/23103835?v=4?s=400","name":"Christoph Fricke","links":[{"icon":"github","link":"https://github.com/christoph-fricke"}],"lastFetch":1718377470627},{"username":"JorrinKievit","avatar":"https://avatars.githubusercontent.com/u/43169049?v=4?s=400","name":"Jorrin","links":[{"icon":"github","link":"https://github.com/JorrinKievit"}],"lastFetch":1718377471579},{"username":"WickyNilliams","avatar":"https://avatars.githubusercontent.com/u/1091390?v=4?s=400","name":"Nick Williams","links":[{"icon":"github","link":"https://github.com/WickyNilliams"}],"lastFetch":1718377472560},{"username":"hrsh7th","avatar":"https://avatars.githubusercontent.com/u/629908?v=4?s=400","name":"hrsh7th","links":[{"icon":"github","link":"https://github.com/hrsh7th"}],"lastFetch":1718377473590},{"username":"davidleger95","avatar":"https://avatars.githubusercontent.com/u/10498708?v=4?s=400","name":"David Leger","links":[{"icon":"github","link":"https://github.com/davidleger95"}],"lastFetch":1718377474537},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1718377475509},{"username":"mzronek","avatar":"https://avatars.githubusercontent.com/u/3847700?v=4?s=400","name":"Matthias Zronek","links":[{"icon":"github","link":"https://github.com/mzronek"}],"lastFetch":1718377476485},{"username":"raurfang","avatar":"https://avatars.githubusercontent.com/u/867241?v=4?s=400","name":"Łukasz Wiśniewski","links":[{"icon":"github","link":"https://github.com/raurfang"}],"lastFetch":1718377477561},{"username":"JeanRemiDelteil","avatar":"https://avatars.githubusercontent.com/u/9743907?v=4?s=400","name":"Jean-Rémi Delteil","links":[{"icon":"github","link":"https://github.com/JeanRemiDelteil"}],"lastFetch":1718377478534},{"username":"TzviPM","avatar":"https://avatars.githubusercontent.com/u/1950680?v=4?s=400","name":"Tzvi Melamed","links":[{"icon":"github","link":"https://github.com/TzviPM"}],"lastFetch":1718377557328},{"username":"LucaSchwan","avatar":"https://avatars.githubusercontent.com/u/25820532?v=4?s=400","name":"ehrenschwan","links":[{"icon":"github","link":"https://github.com/LucaSchwan"}],"lastFetch":1718377558499},{"username":"nzapponi","avatar":"https://avatars.githubusercontent.com/u/20582065?v=4?s=400","name":"Niccolo Zapponi","links":[{"icon":"github","link":"https://github.com/nzapponi"}],"lastFetch":1718377559737},{"username":"luchsamapparat","avatar":"https://avatars.githubusercontent.com/u/875017?v=4?s=400","name":"Marvin Luchs","links":[{"icon":"github","link":"https://github.com/luchsamapparat"}],"lastFetch":1718377561016},{"username":"nmacmunn","avatar":"https://avatars.githubusercontent.com/u/849964?v=4?s=400","name":"Neil MacMunn","links":[{"icon":"github","link":"https://github.com/nmacmunn"}],"lastFetch":1718377562348}],"openapi-fetch":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1718377279194},{"username":"fergusean","avatar":"https://avatars.githubusercontent.com/u/1029297?v=4?s=400","name":"fergusean","links":[{"icon":"github","link":"https://github.com/fergusean"}],"lastFetch":1718377280199},{"username":"shinzui","avatar":"https://avatars.githubusercontent.com/u/519?v=4?s=400","name":"Nadeem Bitar","links":[{"icon":"github","link":"https://github.com/shinzui"}],"lastFetch":1718377281169},{"username":"ezpuzz","avatar":"https://avatars.githubusercontent.com/u/672182?v=4?s=400","name":"Emory Petermann","links":[{"icon":"github","link":"https://github.com/ezpuzz"}],"lastFetch":1718377282178},{"username":"KotoriK","avatar":"https://avatars.githubusercontent.com/u/52659125?v=4?s=400","name":"KotoriK","links":[{"icon":"github","link":"https://github.com/KotoriK"}],"lastFetch":1718377283243},{"username":"fletchertyler914","avatar":"https://avatars.githubusercontent.com/u/3344498?v=4?s=400","name":"Tyler Fletcher","links":[{"icon":"github","link":"https://github.com/fletchertyler914"}],"lastFetch":1718377284335},{"username":"nholik","avatar":"https://avatars.githubusercontent.com/u/2022214?v=4?s=400","name":"Nicklos Holik","links":[{"icon":"github","link":"https://github.com/nholik"}],"lastFetch":1718377285322},{"username":"roj1512","avatar":"https://avatars.githubusercontent.com/u/49933115?v=4?s=400","name":"Roj","links":[{"icon":"github","link":"https://github.com/roj1512"}],"lastFetch":1718377286395},{"username":"nickcaballero","avatar":"https://avatars.githubusercontent.com/u/355976?v=4?s=400","name":"Nick Caballero","links":[{"icon":"github","link":"https://github.com/nickcaballero"}],"lastFetch":1718377287498},{"username":"hd-o","avatar":"https://avatars.githubusercontent.com/u/58871222?v=4?s=400","name":"Hadrian de Oliveira","links":[{"icon":"github","link":"https://github.com/hd-o"}],"lastFetch":1718377288518},{"username":"kecrily","avatar":"https://avatars.githubusercontent.com/u/45708948?v=4?s=400","name":"Percy Ma","links":[{"icon":"github","link":"https://github.com/kecrily"}],"lastFetch":1718377289612},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1718377290624},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1718377291728},{"username":"marcomuser","avatar":"https://avatars.githubusercontent.com/u/64737396?v=4?s=400","name":"Marco Muser","links":[{"icon":"github","link":"https://github.com/marcomuser"}],"lastFetch":1718377292747},{"username":"HugeLetters","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4?s=400","name":"Evgenii Perminov","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1718377293820},{"username":"Fumaz","avatar":"https://avatars.githubusercontent.com/u/45318608?v=4?s=400","name":"alex","links":[{"icon":"github","link":"https://github.com/Fumaz"}],"lastFetch":1718377389094},{"username":"darwish","avatar":"https://avatars.githubusercontent.com/u/292570?v=4?s=400","name":"Mike Darwish","links":[{"icon":"github","link":"https://github.com/darwish"}],"lastFetch":1718377390050},{"username":"kaechele","avatar":"https://avatars.githubusercontent.com/u/454490?v=4?s=400","name":"Felix Kaechele","links":[{"icon":"github","link":"https://github.com/kaechele"}],"lastFetch":1718377391028},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1718377392081},{"username":"mikestopcontinues","avatar":"https://avatars.githubusercontent.com/u/150434?v=4?s=400","name":"Mike Stop Continues","links":[{"icon":"github","link":"https://github.com/mikestopcontinues"}],"lastFetch":1718377393641},{"username":"JE-Lee","avatar":"https://avatars.githubusercontent.com/u/19794813?v=4?s=400","name":"maurice","links":[{"icon":"github","link":"https://github.com/JE-Lee"}],"lastFetch":1718377394619},{"username":"vipentti","avatar":"https://avatars.githubusercontent.com/u/4726680?v=4?s=400","name":"Ville Penttinen","links":[{"icon":"github","link":"https://github.com/vipentti"}],"lastFetch":1718377395545},{"username":"armandabric","avatar":"https://avatars.githubusercontent.com/u/95120?v=4?s=400","name":"Armand Abric","links":[{"icon":"github","link":"https://github.com/armandabric"}],"lastFetch":1718377396502},{"username":"illright","avatar":"https://avatars.githubusercontent.com/u/15035286?v=4?s=400","name":"Lev Chelyadinov","links":[{"icon":"github","link":"https://github.com/illright"}],"lastFetch":1718377397625}],"openapi-react-query":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1719121627033},{"username":"kerwanp","avatar":"https://avatars.githubusercontent.com/u/36955373?v=4?s=400","name":"Martin Paucot","links":[{"icon":"github","link":"https://github.com/kerwanp"}],"lastFetch":1719121628240}]} \ No newline at end of file +{"openapi-typescript":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1722527479765},{"username":"psmyrdek","avatar":"https://avatars.githubusercontent.com/u/6187417?v=4?s=400","name":"Przemek Smyrdek","links":[{"icon":"github","link":"https://github.com/psmyrdek"}],"lastFetch":1722527480891},{"username":"enmand","avatar":"https://avatars.githubusercontent.com/u/432487?v=4?s=400","name":"Dan Enman","links":[{"icon":"github","link":"https://github.com/enmand"}],"lastFetch":1722527482054},{"username":"atlefren","avatar":"https://avatars.githubusercontent.com/u/1829927?v=4?s=400","name":"Atle Frenvik Sveen","links":[{"icon":"github","link":"https://github.com/atlefren"}],"lastFetch":1722527483204},{"username":"tpdewolf","avatar":"https://avatars.githubusercontent.com/u/4455209?v=4?s=400","name":"Tim de Wolf","links":[{"icon":"github","link":"https://github.com/tpdewolf"}],"lastFetch":1722527484314},{"username":"tombarton","avatar":"https://avatars.githubusercontent.com/u/6222711?v=4?s=400","name":"Tom Barton","links":[{"icon":"github","link":"https://github.com/tombarton"}],"lastFetch":1722527485504},{"username":"svnv","avatar":"https://avatars.githubusercontent.com/u/1080888?v=4?s=400","name":"Sven Nicolai Viig","links":[{"icon":"github","link":"https://github.com/svnv"}],"lastFetch":1722527486648},{"username":"sorin-davidoi","avatar":"https://avatars.githubusercontent.com/u/2109702?v=4?s=400","name":"Sorin Davidoi","links":[{"icon":"github","link":"https://github.com/sorin-davidoi"}],"lastFetch":1722527487918},{"username":"scvnathan","avatar":"https://avatars.githubusercontent.com/u/73474?v=4?s=400","name":"Nathan Schneirov","links":[{"icon":"github","link":"https://github.com/scvnathan"}],"lastFetch":1722527489070},{"username":"lbenie","avatar":"https://avatars.githubusercontent.com/u/7316046?v=4?s=400","name":"Lucien Bénié","links":[{"icon":"github","link":"https://github.com/lbenie"}],"lastFetch":1722527490228},{"username":"bokub","avatar":"https://avatars.githubusercontent.com/u/17952318?v=4?s=400","name":"Boris K","links":[{"icon":"github","link":"https://github.com/bokub"}],"lastFetch":1722527491520},{"username":"antonk52","avatar":"https://avatars.githubusercontent.com/u/5817809?v=4?s=400","name":"Anton Kastritskii","links":[{"icon":"github","link":"https://github.com/antonk52"}],"lastFetch":1722527492660},{"username":"tshelburne","avatar":"https://avatars.githubusercontent.com/u/1202267?v=4?s=400","name":"Tim Shelburne","links":[{"icon":"github","link":"https://github.com/tshelburne"}],"lastFetch":1722527493784},{"username":"typeofweb","avatar":"https://avatars.githubusercontent.com/u/1338731?v=4?s=400","name":"Michał Miszczyszyn","links":[{"icon":"github","link":"https://github.com/typeofweb"}],"lastFetch":1722527494978},{"username":"skh-","avatar":"https://avatars.githubusercontent.com/u/1292598?v=4?s=400","name":"Sam K Hall","links":[{"icon":"github","link":"https://github.com/skh-"}],"lastFetch":1722527496072},{"username":"BlooJeans","avatar":"https://avatars.githubusercontent.com/u/1751182?v=4?s=400","name":"Matt Jeanes","links":[{"icon":"github","link":"https://github.com/BlooJeans"}],"lastFetch":1722529378100},{"username":"selbekk","avatar":"https://avatars.githubusercontent.com/u/1307267?v=4?s=400","name":"Kristofer Giltvedt Selbekk","links":[{"icon":"github","link":"https://github.com/selbekk"}],"lastFetch":1722529379284},{"username":"Mause","avatar":"https://avatars.githubusercontent.com/u/1405026?v=4?s=400","name":"Elliana May","links":[{"icon":"github","link":"https://github.com/Mause"}],"lastFetch":1722529380569},{"username":"henhal","avatar":"https://avatars.githubusercontent.com/u/9608258?v=4?s=400","name":"Henrik Hall","links":[{"icon":"github","link":"https://github.com/henhal"}],"lastFetch":1722529381685},{"username":"gr2m","avatar":"https://avatars.githubusercontent.com/u/39992?v=4?s=400","name":"Gregor Martynus","links":[{"icon":"github","link":"https://github.com/gr2m"}],"lastFetch":1722529382927},{"username":"samdbmg","avatar":"https://avatars.githubusercontent.com/u/408983?v=4?s=400","name":"Sam Mesterton-Gibbons","links":[{"icon":"github","link":"https://github.com/samdbmg"}],"lastFetch":1722529384101},{"username":"rendall","avatar":"https://avatars.githubusercontent.com/u/293263?v=4?s=400","name":"Rendall","links":[{"icon":"github","link":"https://github.com/rendall"}],"lastFetch":1722529385262},{"username":"robertmassaioli","avatar":"https://avatars.githubusercontent.com/u/149178?v=4?s=400","name":"Robert Massaioli","links":[{"icon":"github","link":"https://github.com/robertmassaioli"}],"lastFetch":1722529386423},{"username":"jankuca","avatar":"https://avatars.githubusercontent.com/u/367262?v=4?s=400","name":"Jan Kuča","links":[{"icon":"github","link":"https://github.com/jankuca"}],"lastFetch":1722529387591},{"username":"th-m","avatar":"https://avatars.githubusercontent.com/u/13792029?v=4?s=400","name":"Thomas Valadez","links":[{"icon":"github","link":"https://github.com/th-m"}],"lastFetch":1722529388794},{"username":"asithade","avatar":"https://avatars.githubusercontent.com/u/3814354?v=4?s=400","name":"Asitha de Silva","links":[{"icon":"github","link":"https://github.com/asithade"}],"lastFetch":1722529389986},{"username":"misha-erm","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4?s=400","name":"Misha","links":[{"icon":"github","link":"https://github.com/misha-erm"}],"lastFetch":1722529391318},{"username":"radist2s","avatar":"https://avatars.githubusercontent.com/u/725645?v=4?s=400","name":"Alex Batalov","links":[{"icon":"github","link":"https://github.com/radist2s"}],"lastFetch":1722529392410},{"username":"FedeBev","avatar":"https://avatars.githubusercontent.com/u/22151395?v=4?s=400","name":"Federico Bevione","links":[{"icon":"github","link":"https://github.com/FedeBev"}],"lastFetch":1722529393675},{"username":"yamacent","avatar":"https://avatars.githubusercontent.com/u/8544439?v=4?s=400","name":"Daisuke Yamamoto","links":[{"icon":"github","link":"https://github.com/yamacent"}],"lastFetch":1722529394841},{"username":"dnalborczyk","avatar":"https://avatars.githubusercontent.com/u/2903325?v=4?s=400","name":"dnalborczyk","links":[{"icon":"github","link":"https://github.com/dnalborczyk"}],"lastFetch":1722529395933},{"username":"FabioWanner","avatar":"https://avatars.githubusercontent.com/u/46821078?v=4?s=400","name":"FabioWanner","links":[{"icon":"github","link":"https://github.com/FabioWanner"}],"lastFetch":1722529397020},{"username":"ashsmith","avatar":"https://avatars.githubusercontent.com/u/1086841?v=4?s=400","name":"Ash Smith","links":[{"icon":"github","link":"https://github.com/ashsmith"}],"lastFetch":1722529398281},{"username":"mehalter","avatar":"https://avatars.githubusercontent.com/u/1591837?v=4?s=400","name":"Micah Halter","links":[{"icon":"github","link":"https://github.com/mehalter"}],"lastFetch":1722529399512},{"username":"Chrg1001","avatar":"https://avatars.githubusercontent.com/u/40189653?v=4?s=400","name":"chrg1001","links":[{"icon":"github","link":"https://github.com/Chrg1001"}],"lastFetch":1722529416295},{"username":"sharmarajdaksh","avatar":"https://avatars.githubusercontent.com/u/33689528?v=4?s=400","name":"Dakshraj Sharma","links":[{"icon":"github","link":"https://github.com/sharmarajdaksh"}],"lastFetch":1722529417474},{"username":"shuluster","avatar":"https://avatars.githubusercontent.com/u/1707910?v=4?s=400","name":"Shaosu Liu","links":[{"icon":"github","link":"https://github.com/shuluster"}],"lastFetch":1722529418689},{"username":"FDiskas","avatar":"https://avatars.githubusercontent.com/u/468006?v=4?s=400","name":"Vytenis","links":[{"icon":"github","link":"https://github.com/FDiskas"}],"lastFetch":1722529419993},{"username":"ericzorn93","avatar":"https://avatars.githubusercontent.com/u/22532542?v=4?s=400","name":"Eric Zorn","links":[{"icon":"github","link":"https://github.com/ericzorn93"}],"lastFetch":1722529421195},{"username":"mbelsky","avatar":"https://avatars.githubusercontent.com/u/3923527?v=4?s=400","name":"Max Belsky","links":[{"icon":"github","link":"https://github.com/mbelsky"}],"lastFetch":1722529422309},{"username":"techbech","avatar":"https://avatars.githubusercontent.com/u/1520592?v=4?s=400","name":"Peter Bech","links":[{"icon":"github","link":"https://github.com/techbech"}],"lastFetch":1722529423455},{"username":"rustyconover","avatar":"https://avatars.githubusercontent.com/u/731941?v=4?s=400","name":"Rusty Conover","links":[{"icon":"github","link":"https://github.com/rustyconover"}],"lastFetch":1722529424561},{"username":"bunkscene","avatar":"https://avatars.githubusercontent.com/u/2693678?v=4?s=400","name":"Dave Carlson","links":[{"icon":"github","link":"https://github.com/bunkscene"}],"lastFetch":1722529425764},{"username":"ottomated","avatar":"https://avatars.githubusercontent.com/u/31470743?v=4?s=400","name":"ottomated","links":[{"icon":"github","link":"https://github.com/ottomated"}],"lastFetch":1722529426955},{"username":"sadfsdfdsa","avatar":"https://avatars.githubusercontent.com/u/28733669?v=4?s=400","name":"Artem Shuvaev","links":[{"icon":"github","link":"https://github.com/sadfsdfdsa"}],"lastFetch":1722529428220},{"username":"ajaishankar","avatar":"https://avatars.githubusercontent.com/u/328008?v=4?s=400","name":"ajaishankar","links":[{"icon":"github","link":"https://github.com/ajaishankar"}],"lastFetch":1722529429328},{"username":"dominikdosoudil","avatar":"https://avatars.githubusercontent.com/u/15929942?v=4?s=400","name":"Dominik Dosoudil","links":[{"icon":"github","link":"https://github.com/dominikdosoudil"}],"lastFetch":1722529430538},{"username":"kgtkr","avatar":"https://avatars.githubusercontent.com/u/17868838?v=4?s=400","name":"kgtkr","links":[{"icon":"github","link":"https://github.com/kgtkr"}],"lastFetch":1722529431765},{"username":"berzi","avatar":"https://avatars.githubusercontent.com/u/32619123?v=4?s=400","name":"berzi","links":[{"icon":"github","link":"https://github.com/berzi"}],"lastFetch":1722529433067},{"username":"PhilipTrauner","avatar":"https://avatars.githubusercontent.com/u/9287847?v=4?s=400","name":"Philip Trauner","links":[{"icon":"github","link":"https://github.com/PhilipTrauner"}],"lastFetch":1722529434325},{"username":"Powell-v2","avatar":"https://avatars.githubusercontent.com/u/25308326?v=4?s=400","name":"Pavel Yermolin","links":[{"icon":"github","link":"https://github.com/Powell-v2"}],"lastFetch":1722529435485},{"username":"duncanbeevers","avatar":"https://avatars.githubusercontent.com/u/7367?v=4?s=400","name":"Duncan Beevers","links":[{"icon":"github","link":"https://github.com/duncanbeevers"}],"lastFetch":1722529436644},{"username":"tkukushkin","avatar":"https://avatars.githubusercontent.com/u/1482516?v=4?s=400","name":"Timofei Kukushkin","links":[{"icon":"github","link":"https://github.com/tkukushkin"}],"lastFetch":1722529438018},{"username":"Semigradsky","avatar":"https://avatars.githubusercontent.com/u/1198848?v=4?s=400","name":"Dmitry Semigradsky","links":[{"icon":"github","link":"https://github.com/Semigradsky"}],"lastFetch":1722529439220},{"username":"MrLeebo","avatar":"https://avatars.githubusercontent.com/u/2754163?v=4?s=400","name":"Jeremy Liberman","links":[{"icon":"github","link":"https://github.com/MrLeebo"}],"lastFetch":1722529440575},{"username":"axelhzf","avatar":"https://avatars.githubusercontent.com/u/175627?v=4?s=400","name":"Axel Hernández Ferrera","links":[{"icon":"github","link":"https://github.com/axelhzf"}],"lastFetch":1722529441695},{"username":"imagoiq","avatar":"https://avatars.githubusercontent.com/u/12294151?v=4?s=400","name":"Loïc Fürhoff","links":[{"icon":"github","link":"https://github.com/imagoiq"}],"lastFetch":1722529442841},{"username":"BTMPL","avatar":"https://avatars.githubusercontent.com/u/247153?v=4?s=400","name":"Bartosz Szczeciński","links":[{"icon":"github","link":"https://github.com/BTMPL"}],"lastFetch":1722529443973},{"username":"HiiiiD","avatar":"https://avatars.githubusercontent.com/u/61231210?v=4?s=400","name":"Marco Salomone","links":[{"icon":"github","link":"https://github.com/HiiiiD"}],"lastFetch":1722529445071},{"username":"yacinehmito","avatar":"https://avatars.githubusercontent.com/u/6893840?v=4?s=400","name":"Yacine Hmito","links":[{"icon":"github","link":"https://github.com/yacinehmito"}],"lastFetch":1722529446235},{"username":"sajadtorkamani","avatar":"https://avatars.githubusercontent.com/u/9380313?v=4?s=400","name":"Sajad Torkamani","links":[{"icon":"github","link":"https://github.com/sajadtorkamani"}],"lastFetch":1722529447350},{"username":"mvdbeek","avatar":"https://avatars.githubusercontent.com/u/6804901?v=4?s=400","name":"Marius van den Beek","links":[{"icon":"github","link":"https://github.com/mvdbeek"}],"lastFetch":1722529448506},{"username":"sgrimm","avatar":"https://avatars.githubusercontent.com/u/1248649?v=4?s=400","name":"Steven Grimm","links":[{"icon":"github","link":"https://github.com/sgrimm"}],"lastFetch":1722529449638},{"username":"Swiftwork","avatar":"https://avatars.githubusercontent.com/u/455178?v=4?s=400","name":"Erik Hughes","links":[{"icon":"github","link":"https://github.com/Swiftwork"}],"lastFetch":1722529450895},{"username":"mtth","avatar":"https://avatars.githubusercontent.com/u/1216372?v=4?s=400","name":"Matthieu Monsch","links":[{"icon":"github","link":"https://github.com/mtth"}],"lastFetch":1722529452023},{"username":"mitchell-merry","avatar":"https://avatars.githubusercontent.com/u/8567231?v=4?s=400","name":"Mitchell Merry","links":[{"icon":"github","link":"https://github.com/mitchell-merry"}],"lastFetch":1722529453190},{"username":"qnp","avatar":"https://avatars.githubusercontent.com/u/6012554?v=4?s=400","name":"François Risoud","links":[{"icon":"github","link":"https://github.com/qnp"}],"lastFetch":1722529454327},{"username":"shoffmeister","avatar":"https://avatars.githubusercontent.com/u/3868036?v=4?s=400","name":"shoffmeister","links":[{"icon":"github","link":"https://github.com/shoffmeister"}],"lastFetch":1722529455628},{"username":"liangskyli","avatar":"https://avatars.githubusercontent.com/u/31531283?v=4?s=400","name":"liangsky","links":[{"icon":"github","link":"https://github.com/liangskyli"}],"lastFetch":1722529456742},{"username":"happycollision","avatar":"https://avatars.githubusercontent.com/u/3663628?v=4?s=400","name":"Don Denton","links":[{"icon":"github","link":"https://github.com/happycollision"}],"lastFetch":1722529457902},{"username":"ysmood","avatar":"https://avatars.githubusercontent.com/u/1415488?v=4?s=400","name":"Yad Smood","links":[{"icon":"github","link":"https://github.com/ysmood"}],"lastFetch":1722529459105},{"username":"barakalon","avatar":"https://avatars.githubusercontent.com/u/12398927?v=4?s=400","name":"barak","links":[{"icon":"github","link":"https://github.com/barakalon"}],"lastFetch":1722529460278},{"username":"horaklukas","avatar":"https://avatars.githubusercontent.com/u/996088?v=4?s=400","name":"Lukáš Horák","links":[{"icon":"github","link":"https://github.com/horaklukas"}],"lastFetch":1722529461381},{"username":"pvanagtmaal","avatar":"https://avatars.githubusercontent.com/u/5946464?v=4?s=400","name":"pvanagtmaal","links":[{"icon":"github","link":"https://github.com/pvanagtmaal"}],"lastFetch":1722529462505},{"username":"toomuchdesign","avatar":"https://avatars.githubusercontent.com/u/4573549?v=4?s=400","name":"Andrea Carraro","links":[{"icon":"github","link":"https://github.com/toomuchdesign"}],"lastFetch":1722529463718},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1722529464814},{"username":"tkrotoff","avatar":"https://avatars.githubusercontent.com/u/643434?v=4?s=400","name":"Tanguy Krotoff","links":[{"icon":"github","link":"https://github.com/tkrotoff"}],"lastFetch":1722529466070},{"username":"pimveldhuisen","avatar":"https://avatars.githubusercontent.com/u/3043834?v=4?s=400","name":"Pim Veldhuisen","links":[{"icon":"github","link":"https://github.com/pimveldhuisen"}],"lastFetch":1722529467403},{"username":"asvishnyakov","avatar":"https://avatars.githubusercontent.com/u/6369252?v=4?s=400","name":"Aleksandr Vishniakov","links":[{"icon":"github","link":"https://github.com/asvishnyakov"}],"lastFetch":1722529468580},{"username":"SchabaJo","avatar":"https://avatars.githubusercontent.com/u/138689813?v=4?s=400","name":"SchabaJo","links":[{"icon":"github","link":"https://github.com/SchabaJo"}],"lastFetch":1722529469657},{"username":"AhsanFazal","avatar":"https://avatars.githubusercontent.com/u/7458046?v=4?s=400","name":"Ahsan Fazal","links":[{"icon":"github","link":"https://github.com/AhsanFazal"}],"lastFetch":1722529470858},{"username":"ElForastero","avatar":"https://avatars.githubusercontent.com/u/5102818?v=4?s=400","name":"Eugene Dzhumak","links":[{"icon":"github","link":"https://github.com/ElForastero"}],"lastFetch":1722529472214},{"username":"msgadi","avatar":"https://avatars.githubusercontent.com/u/9037086?v=4?s=400","name":"Mohammed Gadi","links":[{"icon":"github","link":"https://github.com/msgadi"}],"lastFetch":1722529473448},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1722529474781},{"username":"christoph-fricke","avatar":"https://avatars.githubusercontent.com/u/23103835?v=4?s=400","name":"Christoph Fricke","links":[{"icon":"github","link":"https://github.com/christoph-fricke"}],"lastFetch":1722529476108},{"username":"JorrinKievit","avatar":"https://avatars.githubusercontent.com/u/43169049?v=4?s=400","name":"Jorrin","links":[{"icon":"github","link":"https://github.com/JorrinKievit"}],"lastFetch":1722529477227},{"username":"WickyNilliams","avatar":"https://avatars.githubusercontent.com/u/1091390?v=4?s=400","name":"Nick Williams","links":[{"icon":"github","link":"https://github.com/WickyNilliams"}],"lastFetch":1722529478342},{"username":"hrsh7th","avatar":"https://avatars.githubusercontent.com/u/629908?v=4?s=400","name":"hrsh7th","links":[{"icon":"github","link":"https://github.com/hrsh7th"}],"lastFetch":1722529479590},{"username":"davidleger95","avatar":"https://avatars.githubusercontent.com/u/10498708?v=4?s=400","name":"David Leger","links":[{"icon":"github","link":"https://github.com/davidleger95"}],"lastFetch":1722529480682},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1722529481830},{"username":"mzronek","avatar":"https://avatars.githubusercontent.com/u/3847700?v=4?s=400","name":"Matthias Zronek","links":[{"icon":"github","link":"https://github.com/mzronek"}],"lastFetch":1722529482970},{"username":"raurfang","avatar":"https://avatars.githubusercontent.com/u/867241?v=4?s=400","name":"Łukasz Wiśniewski","links":[{"icon":"github","link":"https://github.com/raurfang"}],"lastFetch":1722529484195},{"username":"JeanRemiDelteil","avatar":"https://avatars.githubusercontent.com/u/9743907?v=4?s=400","name":"Jean-Rémi Delteil","links":[{"icon":"github","link":"https://github.com/JeanRemiDelteil"}],"lastFetch":1722529485375},{"username":"TzviPM","avatar":"https://avatars.githubusercontent.com/u/1950680?v=4?s=400","name":"Tzvi Melamed","links":[{"icon":"github","link":"https://github.com/TzviPM"}],"lastFetch":1722529486486},{"username":"LucaSchwan","avatar":"https://avatars.githubusercontent.com/u/25820532?v=4?s=400","name":"ehrenschwan","links":[{"icon":"github","link":"https://github.com/LucaSchwan"}],"lastFetch":1722529487670},{"username":"nzapponi","avatar":"https://avatars.githubusercontent.com/u/20582065?v=4?s=400","name":"Niccolo Zapponi","links":[{"icon":"github","link":"https://github.com/nzapponi"}],"lastFetch":1722529488838},{"username":"luchsamapparat","avatar":"https://avatars.githubusercontent.com/u/875017?v=4?s=400","name":"Marvin Luchs","links":[{"icon":"github","link":"https://github.com/luchsamapparat"}],"lastFetch":1722529489993},{"username":"nmacmunn","avatar":"https://avatars.githubusercontent.com/u/849964?v=4?s=400","name":"Neil MacMunn","links":[{"icon":"github","link":"https://github.com/nmacmunn"}],"lastFetch":1722529491134}],"openapi-fetch":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1722527479774},{"username":"fergusean","avatar":"https://avatars.githubusercontent.com/u/1029297?v=4?s=400","name":"fergusean","links":[{"icon":"github","link":"https://github.com/fergusean"}],"lastFetch":1722527480894},{"username":"shinzui","avatar":"https://avatars.githubusercontent.com/u/519?v=4?s=400","name":"Nadeem Bitar","links":[{"icon":"github","link":"https://github.com/shinzui"}],"lastFetch":1722527482050},{"username":"ezpuzz","avatar":"https://avatars.githubusercontent.com/u/672182?v=4?s=400","name":"Emory Petermann","links":[{"icon":"github","link":"https://github.com/ezpuzz"}],"lastFetch":1722527483273},{"username":"KotoriK","avatar":"https://avatars.githubusercontent.com/u/52659125?v=4?s=400","name":"KotoriK","links":[{"icon":"github","link":"https://github.com/KotoriK"}],"lastFetch":1722527484472},{"username":"fletchertyler914","avatar":"https://avatars.githubusercontent.com/u/3344498?v=4?s=400","name":"Tyler Fletcher","links":[{"icon":"github","link":"https://github.com/fletchertyler914"}],"lastFetch":1722527485725},{"username":"nholik","avatar":"https://avatars.githubusercontent.com/u/2022214?v=4?s=400","name":"Nicklos Holik","links":[{"icon":"github","link":"https://github.com/nholik"}],"lastFetch":1722527486881},{"username":"roj1512","avatar":"https://avatars.githubusercontent.com/u/175297870?s=280&v=4","name":"roj1512","links":[{"icon":"github","link":"https://github.com/roj1512"}],"lastFetch":1722527487966},{"username":"nickcaballero","avatar":"https://avatars.githubusercontent.com/u/355976?v=4?s=400","name":"Nick Caballero","links":[{"icon":"github","link":"https://github.com/nickcaballero"}],"lastFetch":1722527489149},{"username":"hd-o","avatar":"https://avatars.githubusercontent.com/u/58871222?v=4?s=400","name":"Hadrian de Oliveira","links":[{"icon":"github","link":"https://github.com/hd-o"}],"lastFetch":1722527490716},{"username":"kecrily","avatar":"https://avatars.githubusercontent.com/u/45708948?v=4?s=400","name":"Percy Ma","links":[{"icon":"github","link":"https://github.com/kecrily"}],"lastFetch":1722527491888},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1722527493010},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1722527494185},{"username":"marcomuser","avatar":"https://avatars.githubusercontent.com/u/64737396?v=4?s=400","name":"Marco Muser","links":[{"icon":"github","link":"https://github.com/marcomuser"}],"lastFetch":1722527495282},{"username":"HugeLetters","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4?s=400","name":"Evgenii Perminov","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1722529378303},{"username":"Fumaz","avatar":"https://avatars.githubusercontent.com/u/45318608?v=4?s=400","name":"alex","links":[{"icon":"github","link":"https://github.com/Fumaz"}],"lastFetch":1722529379750},{"username":"darwish","avatar":"https://avatars.githubusercontent.com/u/292570?v=4?s=400","name":"Mike Darwish","links":[{"icon":"github","link":"https://github.com/darwish"}],"lastFetch":1722529380860},{"username":"kaechele","avatar":"https://avatars.githubusercontent.com/u/454490?v=4?s=400","name":"Felix Kaechele","links":[{"icon":"github","link":"https://github.com/kaechele"}],"lastFetch":1722529382102},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1722529383318},{"username":"mikestopcontinues","avatar":"https://avatars.githubusercontent.com/u/150434?v=4?s=400","name":"Mike Stop Continues","links":[{"icon":"github","link":"https://github.com/mikestopcontinues"}],"lastFetch":1722529384597},{"username":"JE-Lee","avatar":"https://avatars.githubusercontent.com/u/19794813?v=4?s=400","name":"maurice","links":[{"icon":"github","link":"https://github.com/JE-Lee"}],"lastFetch":1722529385763},{"username":"vipentti","avatar":"https://avatars.githubusercontent.com/u/4726680?v=4?s=400","name":"Ville Penttinen","links":[{"icon":"github","link":"https://github.com/vipentti"}],"lastFetch":1722529386840},{"username":"armandabric","avatar":"https://avatars.githubusercontent.com/u/95120?v=4?s=400","name":"Armand Abric","links":[{"icon":"github","link":"https://github.com/armandabric"}],"lastFetch":1722529387928},{"username":"illright","avatar":"https://avatars.githubusercontent.com/u/15035286?v=4?s=400","name":"Lev Chelyadinov","links":[{"icon":"github","link":"https://github.com/illright"}],"lastFetch":1722529389272}],"openapi-react-query":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1722527479768},{"username":"kerwanp","avatar":"https://avatars.githubusercontent.com/u/36955373?v=4?s=400","name":"Martin Paucot","links":[{"icon":"github","link":"https://github.com/kerwanp"}],"lastFetch":1722527480929}]} \ No newline at end of file diff --git a/docs/scripts/update-contributors.js b/docs/scripts/update-contributors.js index 96ac143d9..611e4f4df 100644 --- a/docs/scripts/update-contributors.js +++ b/docs/scripts/update-contributors.js @@ -196,9 +196,12 @@ async function main() { ? OPENAPI_REACT_QUERY_CONTRIBUTORS : OPENAPI_TS_CONTRIBUTORS; for (const username of userlist) { + i++; // skip profiles that have been updated within the past week const { lastFetch } = contributors[repo].find((u) => u.username === username) ?? { lastFetch: 0 }; if (Date.now() - lastFetch < ONE_MONTH) { + // biome-ignore lint/suspicious/noConsoleLog: this is a script + console.log(`[${i}/${total}] (Skipped ${username})`); continue; } @@ -212,11 +215,10 @@ async function main() { lastFetch: new Date().getTime(), }; upsert(contributors[repo], userData); - i++; - // biome-ignore lint/suspicious/noConsoleLog: this is a script + // biome-ignore lint/suspicious/noConsoleLog: this is a script console.log(`[${i}/${total}] Updated for ${username}`); fs.writeFileSync(new URL("../data/contributors.json", import.meta.url), JSON.stringify(contributors)); // update file while fetching (sync happens safely in between fetches) - await new Promise((resolve) => setTimeout(resolve, 900)); // sleep to prevent 429 + await new Promise((resolve) => setTimeout(resolve, 1000)); // sleep to prevent 429 } catch (err) { throw new Error(err); } diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index 248b0a0f0..e04ea094b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -970,7 +970,6 @@ export interface paths { * List Database Options * @description To list all of the options available for the offered database engines, send a GET request to `/v2/databases/options`. * The result will be a JSON object with an `options` key. - * OpenSearch is in closed beta. To request access, [contact support](https://cloudsupport.digitalocean.com). */ get: operations["databases_list_options"]; put?: never; @@ -1009,7 +1008,6 @@ export interface paths { * * DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. * Note: Backups are not supported for Redis clusters. - * OpenSearch is in closed beta. To request access, [contact support](https://cloudsupport.digitalocean.com). */ post: operations["databases_create_cluster"]; delete?: never; @@ -1803,6 +1801,73 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/{database_cluster_uuid}/logsink": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Logsinks for a Database Cluster + * + * @description To list logsinks for a database cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/logsink`. + * + */ + get: operations["databases_list_logsink"]; + put?: never; + /** + * Create Logsink for a Database Cluster + * + * @description To create logsink for a database cluster, send a POST request to + * `/v2/databases/$DATABASE_ID/logsink`. + * + */ + post: operations["databases_create_logsink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/databases/{database_cluster_uuid}/logsink/{logsink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Logsink for a Database Cluster + * + * @description To get a logsink for a database cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. + * + */ + get: operations["databases_get_logsink"]; + /** + * Update Logsink for a Database Cluster + * + * @description To update a logsink for a database cluster, send a PUT request to + * `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. + * + */ + put: operations["databases_update_logsink"]; + post?: never; + /** + * Delete Logsink for a Database Cluster + * + * @description To delete a logsink for a database cluster, send a DELETE request to + * `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. + * + */ + delete: operations["databases_delete_logsink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/databases/metrics/credentials": { parameters: { query?: never; @@ -5949,23 +6014,26 @@ export interface components { /** @description Configure Username and/or Password for Basic authentication. */ app_log_destination_open_search_spec_basic_auth: { /** - * @description Username to authenticate with. + * @description Username to authenticate with. Only required when `endpoint` is set. + * Defaults to `doadmin` when `cluster_name` is set. * @example apps_user */ - user: string; + user?: string; /** - * @description Password for user defined in User. + * @description Password for user defined in User. Is required when `endpoint` is set. + * Cannot be set if using a DigitalOcean DBaaS OpenSearch cluster. * @example password1 */ - password: string; + password?: unknown; }; /** @description OpenSearch configuration. */ app_log_destination_open_search_spec: { /** - * @description OpenSearch API Endpoint. Only HTTPS is supported. Format: `https://:`. + * @description OpenSearch API Endpoint. Only HTTPS is supported. Format: https://:. + * Cannot be specified if `cluster_name` is also specified. * @example https://example.com:9300 */ - endpoint: string; + endpoint?: string; basic_auth?: components["schemas"]["app_log_destination_open_search_spec_basic_auth"]; /** * @description The index name to use for the logs. If not set, the default index name is "logs". @@ -5973,6 +6041,12 @@ export interface components { * @example logs */ index_name: string; + /** + * @description The name of a DigitalOcean DBaaS OpenSearch cluster to use as a log forwarding destination. + * Cannot be specified if `endpoint` is also specified. + * @example my-opensearch-cluster + */ + cluster_name?: string; }; /** Configurations for external logging. */ app_log_destination_definition: { @@ -6073,6 +6147,7 @@ export interface components { */ exact?: string; /** + * @deprecated * @description Prefix-based match. Only 1 of `exact`, `prefix`, or `regex` must be set. * @example https://www.example.com */ @@ -6373,13 +6448,14 @@ export interface components { * - REDIS: Redis * - MONGODB: MongoDB * - KAFKA: Kafka + * - OPENSEARCH: OpenSearch * @default UNSET * @example PG * @enum {string} */ - engine: "UNSET" | "MYSQL" | "PG" | "REDIS" | "MONGODB" | "KAFKA"; + engine: "UNSET" | "MYSQL" | "PG" | "REDIS" | "MONGODB" | "KAFKA" | "OPENSEARCH"; /** - * @description The name. Must be unique across all components within the same app. + * @description The database's name. The name must be unique across all components within the same app and cannot use capital letters. * @example prod-db */ name: string; @@ -8087,7 +8163,7 @@ export interface components { */ name: string; /** - * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" for OpenSearch. OpenSearch is in closed beta. To request access, [contact support](https://cloudsupport.digitalocean.com). + * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka, and "opensearch" for OpenSearch. * @example mysql * @enum {string} */ @@ -8194,7 +8270,7 @@ export interface components { */ backup_created_at?: string; }; - mysql: { + mysql_advanced_config: { /** * @description The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. * @example 3 @@ -8367,7 +8443,7 @@ export interface components { net_buffer_length?: number; }; /** @description PGBouncer connection pooling settings */ - pgbouncer: { + pgbouncer_advanced_config: { /** * @description Run server_reset_query (DISCARD ALL) in all pooling modes. * @example false @@ -8419,14 +8495,14 @@ export interface components { autodb_idle_timeout?: number; }; /** @description TimescaleDB extension configuration values */ - timescaledb: { + timescaledb_advanced_config: { /** * @description The number of background workers for timescaledb operations. Set to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. * @example 8 */ max_background_workers?: number; }; - postgres: { + postgres_advanced_config: { /** * @description Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted. * @example 200000000 @@ -8674,13 +8750,13 @@ export interface components { * @example 41.5 */ shared_buffers_percentage?: number; - pgbouncer?: components["schemas"]["pgbouncer"]; + pgbouncer?: components["schemas"]["pgbouncer_advanced_config"]; /** * @description The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB). * @example 4 */ work_mem?: number; - timescaledb?: components["schemas"]["timescaledb"]; + timescaledb?: components["schemas"]["timescaledb_advanced_config"]; /** * @description Synchronous replication type. Note that the service plan also needs to support synchronous replication. * @example off @@ -8706,7 +8782,7 @@ export interface components { * @enum {string} */ eviction_policy_model: "noeviction" | "allkeys_lru" | "allkeys_random" | "volatile_lru" | "volatile_random" | "volatile_ttl"; - redis: { + redis_advanced_config: { redis_maxmemory_policy?: components["schemas"]["eviction_policy_model"]; /** * @description Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. @@ -8781,40 +8857,7 @@ export interface components { */ redis_acl_channels_default?: "allchannels" | "resetchannels"; }; - mongo: { - /** - * @description Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/). - * @default local - * @example local - * @enum {string} - */ - default_read_concern: "local" | "available" | "majority"; - /** - * @description Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority` or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. Setting to `0` will request no acknowledgement of the write operation. Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/). - * @default majority - * @example majority - */ - default_write_concern: string; - /** - * @description Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds). - * @default 60 - * @example 100 - */ - transaction_lifetime_limit_seconds: number; - /** - * @description Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs). - * @default 100 - * @example 200 - */ - slow_op_threshold_ms: number; - /** - * @description The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. 0 includes informational messages while 1...5 increases the level to include debug messages. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity). - * @default 0 - * @example 3 - */ - verbosity: number; - }; - kafka: { + kafka_advanced_config: { /** * @description Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. * @example gzip @@ -9014,8 +9057,252 @@ export interface components { */ transaction_remove_expired_transaction_cleanup_interval_ms?: number; }; + opensearch_advanced_config: { + /** + * @description Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. + * @default 100000000 + * @example 100000000 + */ + http_max_content_length_bytes: number; + /** + * @description Maximum size of allowed headers, in bytes. + * @default 8192 + * @example 8192 + */ + http_max_header_size_bytes: number; + /** + * @description Maximum length of an HTTP URL, in bytes. + * @default 4096 + * @example 4096 + */ + http_max_initial_line_length_bytes: number; + /** + * @description Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. + * @default 1024 + * @example 1024 + */ + indices_query_bool_max_clause_count: number; + /** + * @description Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations. + * @example 3 + */ + indices_fielddata_cache_size_percentage?: number; + /** + * @description Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. + * @default 10 + * @example 10 + */ + indices_memory_index_buffer_size_percentage: number; + /** + * @description Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. + * @default 48 + * @example 48 + */ + indices_memory_min_index_buffer_size_mb: number; + /** + * @description Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded. + * @example 48 + */ + indices_memory_max_index_buffer_size_mb?: number; + /** + * @description Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. + * @default 10 + * @example 10 + */ + indices_queries_cache_size_percentage: number; + /** + * @description Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). + * @default 40 + * @example 40 + */ + indices_recovery_max_mb_per_sec: number; + /** + * @description Maximum number of file chunks sent in parallel for each recovery. + * @default 2 + * @example 2 + */ + indices_recovery_max_concurrent_file_chunks: number; + /** + * @description Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + * @example 1 + */ + thread_pool_search_size?: number; + /** + * @description Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + * @example 1 + */ + thread_pool_search_throttled_size?: number; + /** + * @description Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + * @example 1 + */ + thread_pool_get_size?: number; + /** + * @description Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + * @example 1 + */ + thread_pool_analyze_size?: number; + /** + * @description Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + * @example 1 + */ + thread_pool_write_size?: number; + /** + * @description Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + * @example 1 + */ + thread_pool_force_merge_size?: number; + /** + * @description Size of queue for operations in the search thread pool. + * @example 10 + */ + thread_pool_search_queue_size?: number; + /** + * @description Size of queue for operations in the search throttled thread pool. + * @example 10 + */ + thread_pool_search_throttled_queue_size?: number; + /** + * @description Size of queue for operations in the get thread pool. + * @example 10 + */ + thread_pool_get_queue_size?: number; + /** + * @description Size of queue for operations in the analyze thread pool. + * @example 10 + */ + thread_pool_analyze_queue_size?: number; + /** + * @description Size of queue for operations in the write thread pool. + * @example 10 + */ + thread_pool_write_queue_size?: number; + /** + * @description Specifies whether ISM is enabled or not. + * @default true + * @example true + */ + ism_enabled: boolean; + /** + * @description Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. + * @default true + * @example true + */ + ism_history_enabled: boolean; + /** + * @description Maximum age before rolling over the audit history index, in hours. + * @default 24 + * @example 24 + */ + ism_history_max_age_hours: number; + /** + * @description Maximum number of documents before rolling over the audit history index. + * @default 2500000 + * @example 2500000 + */ + ism_history_max_docs: number; + /** + * @description The time between rollover checks for the audit history index, in hours. + * @default 8 + * @example 8 + */ + ism_history_rollover_check_period_hours: number; + /** + * @description Length of time long audit history indices are kept, in days. + * @default 30 + * @example 30 + */ + ism_history_rollover_retention_period_days: number; + /** + * @description Maximum number of aggregation buckets allowed in a single response. + * @default 10000 + * @example 10000 + */ + search_max_buckets: number; + /** + * @description Specifices whether to allow automatic creation of indices. + * @default true + * @example true + */ + action_auto_create_index_enabled: boolean; + /** + * @description Specifies whether to allow security audit logging. + * @default false + * @example false + */ + enable_security_audit: boolean; + /** + * @description Specifies whether to require explicit index names when deleting indices. + * @example false + */ + action_destructive_requires_name?: boolean; + /** + * @description Maximum number of shards allowed per data node. + * @example 100 + */ + cluster_max_shards_per_node?: number; + /** + * @description Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. + * @default false + * @example false + */ + override_main_response_version: boolean; + /** + * @description Limits the number of inline script compilations within a period of time. Default is use-context + * @default use-context + * @example 75/5m + */ + script_max_compilations_rate: string; + /** + * @description Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node . + * @default 2 + * @example 2 + */ + cluster_routing_allocation_node_concurrent_recoveries: number; + /** + * @description Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart. + * @example [ + * "255.255.223.233:9200", + * "222.33.222.222:6300" + * ] + */ + reindex_remote_whitelist?: string[]; + }; + mongo_advanced_config: { + /** + * @description Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/). + * @default local + * @example local + * @enum {string} + */ + default_read_concern: "local" | "available" | "majority"; + /** + * @description Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority` or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. Setting to `0` will request no acknowledgement of the write operation. Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/). + * @default majority + * @example majority + */ + default_write_concern: string; + /** + * @description Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds). + * @default 60 + * @example 100 + */ + transaction_lifetime_limit_seconds: number; + /** + * @description Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs). + * @default 100 + * @example 200 + */ + slow_op_threshold_ms: number; + /** + * @description The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. 0 includes informational messages while 1...5 increases the level to include debug messages. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity). + * @default 0 + * @example 3 + */ + verbosity: number; + }; database_config: { - config?: components["schemas"]["mysql"] | components["schemas"]["postgres"] | components["schemas"]["redis"] | components["schemas"]["mongo"] | components["schemas"]["kafka"]; + config?: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["mongo_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"]; }; ca: { /** @@ -9502,6 +9789,163 @@ export interface components { partition_count?: number; config?: components["schemas"]["kafka_topic_config"]; }; + logsink_base_verbose: { + /** + * @description A unique identifier for Logsink + * @example dfcc9f57d86bf58e321c2c6c31c7a971be244ac7 + */ + sink_id?: string; + /** + * @description The name of the Logsink + * @example prod-logsink + */ + sink_name?: string; + /** + * @example rsyslog + * @enum {string} + */ + sink_type?: "rsyslog" | "elasticsearch" | "opensearch"; + }; + rsyslog_logsink: { + /** + * @description DNS name or IPv4 address of the rsyslog server + * @example 192.168.0.1 + */ + server: string; + /** + * @description The internal port on which the rsyslog server is listening + * @example 514 + */ + port: number; + /** + * @description Use TLS (as the messages are not filtered and may contain sensitive information, it is highly recommended to set this to true if the remote server supports it) + * @example false + */ + tls: boolean; + /** + * @description Message format used by the server, this can be either rfc3164 (the old BSD style message format), `rfc5424` (current syslog message format) or custom + * @example rfc5424 + * @enum {string} + */ + format: "rfc5424" | "rfc3164" | "custom"; + /** + * @description Conditional (required if `format` == `custom`). + * + * Syslog log line template for a custom format, supporting limited rsyslog style templating (using `%tag%`). Supported tags are: `HOSTNAME`, `app-name`, `msg`, `msgid`, `pri`, `procid`, `structured-data`, `timestamp` and `timestamp:::date-rfc3339`. + * + * @example <%pri%>%timestamp:::date-rfc3339% %HOSTNAME% %app-name% %msg% + */ + logline?: string; + /** + * @description content of the structured data block of rfc5424 message + * @example TOKEN tag="LiteralValue" + */ + sd?: string; + /** + * @description PEM encoded CA certificate + * @example -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + */ + ca?: string; + /** + * @description (PEM format) client key if the server requires client authentication + * @example -----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n + */ + key?: string; + /** + * @description (PEM format) client cert to use + * @example -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + */ + cert?: string; + }; + elasticsearch_logsink: { + /** + * @description Elasticsearch connection URL + * @example https://user:passwd@192.168.0.1:9200 + */ + url: string; + /** + * @description Elasticsearch index prefix + * @example elastic-logs + */ + index_prefix: string; + /** + * @description Maximum number of days of logs to keep + * @default 7 + * @example 5 + */ + index_days_max: number; + /** + * Format: float + * @description Elasticsearch request timeout limit + * @default 10 + * @example 10 + */ + timeout: number; + /** + * @description PEM encoded CA certificate + * @example -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + */ + ca?: string; + }; + opensearch_logsink: { + /** + * @description Opensearch connection URL + * @example https://user:passwd@192.168.0.1:9200 + */ + url: string; + /** + * @description Opensearch index prefix + * @example opensearch-logs + */ + index_prefix: string; + /** + * @description Maximum number of days of logs to keep + * @default 7 + * @example 5 + */ + index_days_max: number; + /** + * Format: float + * @description Opensearch request timeout limit + * @default 10 + * @example 10 + */ + timeout: number; + /** + * @description PEM encoded CA certificate + * @example -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + */ + ca?: string; + }; + logsink_verbose: components["schemas"]["logsink_base_verbose"] & { + /** @example { + * "config": { + * "server": "192.168.0.1", + * "port": 514, + * "tls": false, + * "format": "rfc5424" + * } + * } */ + config?: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"]; + }; + logsink_base: { + /** + * @description The name of the Logsink + * @example prod-logsink + */ + sink_name?: string; + /** + * @example rsyslog + * @enum {string} + */ + sink_type?: "rsyslog" | "elasticsearch" | "opensearch"; + }; + logsink_create: components["schemas"]["logsink_base"] & { + config?: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"]; + }; + logsink_update: { + config: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"]; + }; databases_basic_auth_credentials: { /** * @description basic authentication username for metrics HTTP endpoint @@ -10805,6 +11249,22 @@ export interface components { */ day?: "any" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; } | null; + /** @description An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only). */ + control_plane_firewall: { + /** + * @description Indicates whether the control plane firewall is enabled. + * @example true + */ + enable?: boolean; + /** + * @description An array of public addresses (IPv4 or CIDR) allowed to access the control plane. + * @example [ + * "1.2.3.4/32", + * "1.1.0.0/16" + * ] + */ + allowed_addresses?: string[]; + } | null; cluster: { /** * Format: uuid @@ -10916,6 +11376,7 @@ export interface components { * @example true */ readonly registry_enabled?: boolean; + control_plane_firewall?: components["schemas"]["control_plane_firewall"]; }; cluster_update: { /** @@ -10952,6 +11413,7 @@ export interface components { * @example true */ ha: boolean; + control_plane_firewall?: components["schemas"]["control_plane_firewall"]; }; associated_kubernetes_resource: { /** @@ -11614,7 +12076,7 @@ export interface components { * } */ metric: { - [key: string]: string | undefined; + [key: string]: string; }; /** @example [ * [ @@ -13300,7 +13762,7 @@ export interface components { }; content: { "application/json": { - config: components["schemas"]["mysql"] | components["schemas"]["postgres"] | components["schemas"]["redis"]; + config: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"] | components["schemas"]["mongo_advanced_config"]; }; }; }; @@ -13546,6 +14008,32 @@ export interface components { }; }; }; + /** @description A JSON object with a key of `sinks`. */ + logsinks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + sinks?: components["schemas"]["logsink_verbose"][]; + }; + }; + }; + /** @description A JSON object with a key of `sink`. */ + logsink: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["logsink_verbose"]; + }; + }; /** @description A JSON object with a key of `credentials`. */ database_metrics_auth: { headers: { @@ -15456,6 +15944,11 @@ export interface components { * @example customer-events */ kafka_topic_name: string; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: string; /** * @description The name of the domain itself. * @example example.com @@ -18603,6 +19096,152 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + databases_list_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 201: components["responses"]["logsinks"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + databases_create_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["logsink_create"]; + }; + }; + responses: { + 201: components["responses"]["logsink"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + databases_get_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 201: components["responses"]["logsink"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + databases_update_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + /** @example { + * "config": { + * "server": "192.168.0.1", + * "port": 514, + * "tls": false, + * "format": "rfc3164" + * } + * } */ + "application/json": components["schemas"]["logsink_update"]; + }; + }; + responses: { + 200: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + databases_delete_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; databases_get_cluster_metrics_credentials: { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml index 089ba19af..55f73fc58 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml +++ b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml @@ -144,8 +144,9 @@ tags: simplifies the creation and management of highly available database clusters. Currently, it offers support for [PostgreSQL](http://www.digitalocean.com/docs/databases/postgresql/), [Redis](https://www.digitalocean.com/docs/databases/redis/), - [MySQL](https://www.digitalocean.com/docs/databases/mysql/), and - [MongoDB](https://www.digitalocean.com/docs/databases/mongodb/). + [MySQL](https://www.digitalocean.com/docs/databases/mysql/), + [MongoDB](https://www.digitalocean.com/docs/databases/mongodb/), and + [OpenSearch](https://docs.digitalocean.com/products/databases/opensearch/). By sending requests to the `/v2/databases` endpoint, you can list, create, or delete database clusters as well as scale the size of a cluster, add or remove read-only replicas, @@ -839,6 +840,21 @@ paths: $ref: 'resources/databases/databases_update_kafka_topic.yml' delete: $ref: 'resources/databases/databases_delete_kafka_topic.yml' + + /v2/databases/{database_cluster_uuid}/logsink: + get: + $ref: 'resources/databases/databases_list_logsink.yml' + post: + $ref: 'resources/databases/databases_create_logsink.yml' + + /v2/databases/{database_cluster_uuid}/logsink/{logsink_id}: + get: + $ref: 'resources/databases/databases_get_logsink.yml' + put: + $ref: 'resources/databases/databases_update_logsink.yml' + delete: + $ref: 'resources/databases/databases_delete_logsink.yml' + /v2/databases/metrics/credentials: get: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml index b0ab64e6a..b3c7648d9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml @@ -53,5 +53,5 @@ responses: security: - bearer_auth: - - 'app:create' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml index 42113ff07..712c9ddb8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml @@ -81,7 +81,7 @@ source: |- "token": "abcdefghijklmnopqrstuvwxyz0123456789" }, "open_search": { - "endpoint": "myopensearchendpoint.com:9300" + "endpoint": "https://myopensearchendpoint.com:9300" "index_name": "logs" "basic_auth": { "user": "doadmin", @@ -134,7 +134,7 @@ source: |- "token": "abcdefghijklmnopqrstuvwxyz0123456789" }, "open_search": { - "endpoint": "myopensearchendpoint.com:9300" + "endpoint": "https://myopensearchendpoint.com:9300" "index_name": "logs" "basic_auth": { "user": "doadmin", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml index 123ae15eb..6b7deba03 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml @@ -1,7 +1,8 @@ type: object properties: cluster_name: - description: The name of the underlying DigitalOcean DBaaS cluster. This is required + description: + The name of the underlying DigitalOcean DBaaS cluster. This is required for production databases. For dev databases, if cluster_name is not set, a new cluster will be provisioned. type: string @@ -21,22 +22,24 @@ properties: type: string default: UNSET enum: - - UNSET - - MYSQL - - PG - - REDIS - - MONGODB - - KAFKA + - UNSET + - MYSQL + - PG + - REDIS + - MONGODB + - KAFKA + - OPENSEARCH description: |- - MYSQL: MySQL - PG: PostgreSQL - REDIS: Redis - MONGODB: MongoDB - KAFKA: Kafka + - OPENSEARCH: OpenSearch example: PG name: - description: The name. Must be unique across all components within the same app. + description: The database's name. The name must be unique across all components within the same app and cannot use capital letters. maxLength: 32 minLength: 2 pattern: ^[a-z][a-z0-9-]{0,30}[a-z0-9]$ @@ -54,4 +57,4 @@ properties: example: "12" required: -- name + - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec.yml index b6b6107a7..2bc9f27eb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec.yml @@ -2,8 +2,9 @@ type: object properties: endpoint: type: string - description: >- - OpenSearch API Endpoint. Only HTTPS is supported. Format: `https://:`. + description: |- + OpenSearch API Endpoint. Only HTTPS is supported. Format: https://:. + Cannot be specified if `cluster_name` is also specified. example: "https://example.com:9300" basic_auth: $ref: app_log_destination_open_search_spec_basic_auth.yml @@ -14,6 +15,10 @@ properties: The index name to use for the logs. If not set, the default index name is "logs". example: logs + cluster_name: + type: string + description: |- + The name of a DigitalOcean DBaaS OpenSearch cluster to use as a log forwarding destination. + Cannot be specified if `endpoint` is also specified. + example: my-opensearch-cluster description: OpenSearch configuration. -required: - - endpoint diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml index aab35bdcd..275198b8b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml @@ -2,13 +2,13 @@ type: object properties: user: type: string - description: Username to authenticate with. + description: |- + Username to authenticate with. Only required when `endpoint` is set. + Defaults to `doadmin` when `cluster_name` is set. example: apps_user password: - type: string - description: Password for user defined in User. + description: |- + Password for user defined in User. Is required when `endpoint` is set. + Cannot be set if using a DigitalOcean DBaaS OpenSearch cluster. example: password1 description: Configure Username and/or Password for Basic authentication. -required: - - user - - password diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_string_match.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_string_match.yml index 0bf30184d..dd06a4731 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_string_match.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_string_match.yml @@ -15,6 +15,7 @@ properties: maxLength: 256 minLength: 1 example: https://www.example.com + deprecated: true regex: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml index 8089cffac..11868c762 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml @@ -27,8 +27,6 @@ description: >- Note: Backups are not supported for Redis clusters. - OpenSearch is in closed beta. To request access, [contact support](https://cloudsupport.digitalocean.com). - tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml new file mode 100644 index 000000000..9971a95e1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml @@ -0,0 +1,78 @@ +operationId: databases_create_logsink + +summary: > + Create Logsink for a Database Cluster + +description: | + To create logsink for a database cluster, send a POST request to + `/v2/databases/$DATABASE_ID/logsink`. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + +requestBody: + required: true + content: + application/json: + schema: + allOf: + - $ref: models/logsink_create.yml + required: + - sink_name + - sink_type + - config + examples: + Create an opensearch logsink: + value: + sink_name: "logs-sink" + sink_type: "opensearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "opensearch-logs" + index_days_max: 5 + Create an elasticsearch logsink: + value: + sink_name: "logs-sink" + sink_type: "elasticsearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "elasticsearch-logs" + index_days_max: 5 + Create a rsyslog logsink: + value: + sink_name: "logs-sink" + sink_type: "rsyslog" + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc5424 + +responses: + "201": + $ref: "responses/logsink.yml" + + "401": + $ref: "../../shared/responses/unauthorized.yml" + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: "../../shared/responses/server_error.yml" + + default: + $ref: "../../shared/responses/unexpected_error.yml" + +x-codeSamples: + - $ref: "examples/curl/databases_create_logsink.yml" + +security: + - bearer_auth: + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_logsink.yml new file mode 100644 index 000000000..ec0bffeb8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_logsink.yml @@ -0,0 +1,41 @@ +operationId: databases_delete_logsink + +summary: > + Delete Logsink for a Database Cluster + +description: | + To delete a logsink for a database cluster, send a DELETE request to + `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/logsink_id" + +responses: + "200": + $ref: "../../shared/responses/no_content.yml" + + "401": + $ref: "../../shared/responses/unauthorized.yml" + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: "../../shared/responses/server_error.yml" + + default: + $ref: "../../shared/responses/unexpected_error.yml" + +x-codeSamples: + - $ref: "examples/curl/databases_delete_logsink.yml" + +security: + - bearer_auth: + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml new file mode 100644 index 000000000..e87955b57 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml @@ -0,0 +1,41 @@ +operationId: databases_get_logsink + +summary: > + Get Logsink for a Database Cluster + +description: | + To get a logsink for a database cluster, send a GET request to + `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/logsink_id" + +responses: + "201": + $ref: "responses/logsink.yml" + + "401": + $ref: "../../shared/responses/unauthorized.yml" + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: "../../shared/responses/server_error.yml" + + default: + $ref: "../../shared/responses/unexpected_error.yml" + +x-codeSamples: + - $ref: "examples/curl/databases_get_logsink.yml" + +security: + - bearer_auth: + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml new file mode 100644 index 000000000..5164d82de --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml @@ -0,0 +1,40 @@ +operationId: databases_list_logsink + +summary: > + List Logsinks for a Database Cluster + +description: | + To list logsinks for a database cluster, send a GET request to + `/v2/databases/$DATABASE_ID/logsink`. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + +responses: + "201": + $ref: "responses/logsinks.yml" + + "401": + $ref: "../../shared/responses/unauthorized.yml" + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: "../../shared/responses/server_error.yml" + + default: + $ref: "../../shared/responses/unexpected_error.yml" + +x-codeSamples: + - $ref: "examples/curl/databases_list_logsink.yml" + +security: + - bearer_auth: + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml index de76a4afe..7be7fa908 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml @@ -8,8 +8,6 @@ description: >- The result will be a JSON object with an `options` key. - OpenSearch is in closed beta. To request access, [contact support](https://cloudsupport.digitalocean.com). - tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_logsink.yml new file mode 100644 index 000000000..b73568063 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_logsink.yml @@ -0,0 +1,54 @@ +operationId: databases_update_logsink + +summary: > + Update Logsink for a Database Cluster + +description: | + To update a logsink for a database cluster, send a PUT request to + `/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID`. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/logsink_id" + +requestBody: + required: true + content: + application/json: + schema: + $ref: "models/logsink_update.yml" + example: + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc3164 + +responses: + "200": + $ref: "../../shared/responses/no_content.yml" + + "401": + $ref: "../../shared/responses/unauthorized.yml" + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: "../../shared/responses/server_error.yml" + + default: + $ref: "../../shared/responses/unexpected_error.yml" + +x-codeSamples: + - $ref: "examples/curl/databases_update_logsink.yml" + +security: + - bearer_auth: + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_logsink.yml new file mode 100644 index 000000000..3850ade3d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_logsink.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"sink_name": "logsink", "sink_type": "rsyslog", "config": {"server": "192.168.10.1", "port": 514, "tls": false, "format": "rfc5424"}}' \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/logsink" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_delete_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_delete_logsink.yml new file mode 100644 index 000000000..93170d484 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_delete_logsink.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/logsink/77b28fc8-19ff-11eb-8c9c-c68e24557488" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_logsink.yml new file mode 100644 index 000000000..988e55176 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_logsink.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/logsink/77b28fc8-19ff-11eb-8c9c-c68e24557488" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_logsink.yml new file mode 100644 index 000000000..e854608e9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_logsink.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/logsink" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_logsink.yml new file mode 100644 index 000000000..9ac6dca10 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_logsink.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"config": {"server": "192.168.1.1", "port": 514, "tls": false, "format": "rfc3164"}}' \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/logsink/77b28fc8-19ff-11eb-8c9c-c68e24557488" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml new file mode 100644 index 000000000..a9e9b959f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml @@ -0,0 +1,328 @@ +type: object + +properties: + compression_type: + description: >- + Specify the final compression type for a given topic. This + configuration accepts the standard compression codecs ('gzip', 'snappy', + 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent + to no compression; and 'producer' which means retain the original + compression codec set by the producer. + type: string + enum: + - gzip + - snappy + - lz4 + - zstd + - uncompressed + - producer + example: gzip + group_initial_rebalance_delay_ms: + description: >- + The amount of time, in milliseconds, the group coordinator + will wait for more consumers to join a new group before performing + the first rebalance. A longer delay means potentially fewer rebalances, + but increases the time until processing begins. The default value + for this is 3 seconds. During development and testing it might be + desirable to set this to 0 in order to not delay test execution time. + type: integer + example: 3000 + minimum: 0 + maximum: 300000 + group_min_session_timeout_ms: + description: >- + The minimum allowed session timeout for registered consumers. + Longer timeouts give consumers more time to process messages in between + heartbeats at the cost of a longer time to detect failures. + type: integer + example: 6000 + minimum: 0 + maximum: 60000 + group_max_session_timeout_ms: + description: >- + The maximum allowed session timeout for registered consumers. + Longer timeouts give consumers more time to process messages in between + heartbeats at the cost of a longer time to detect failures. + type: integer + example: 1800000 + minimum: 0 + maximum: 1800000 + connections_max_idle_ms: + description: >- + Idle connections timeout: the server socket processor + threads close the connections that idle for longer than this. + type: integer + minimum: 1000 + example: 540000 + maximum: 3600000 + max_incremental_fetch_session_cache_slots: + description: >- + The maximum number of incremental fetch sessions that the + broker will maintain. + type: integer + example: 1000 + minimum: 1000 + maximum: 10000 + message_max_bytes: + description: >- + The maximum size of message that the server can receive. + type: integer + example: 1048588 + minimum: 0 + maximum: 100001200 + offsets_retention_minutes: + description: >- + Log retention window in minutes for offsets topic + type: integer + example: 10080 + minimum: 1 + maximum: 2147483647 + log_cleaner_delete_retention_ms: + description: >- + How long are delete records retained? + type: integer + minimum: 0 + maximum: 315569260000 + example: 86400000 + log_cleaner_min_cleanable_ratio: + description: >- + Controls log compactor frequency. Larger value means more + frequent compactions but also more space wasted for logs. Consider + setting log_cleaner_max_compaction_lag_ms to enforce compactions sooner, + instead of setting a very high value for this option. + type: number + minimum: 0.2 + maximum: 0.9 + example: 0.5 + log_cleaner_max_compaction_lag_ms: + description: >- + The maximum amount of time message will remain uncompacted. + Only applicable for logs that are being compacted + type: integer + minimum: 30000 + maximum: 9223372036854776000 + example: 60000 + log_cleaner_min_compaction_lag_ms: + description: >- + The minimum time a message will remain uncompacted in the + log. Only applicable for logs that are being compacted. + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 100000 + log_cleanup_policy: + description: >- + The default cleanup policy for segments beyond the retention + window + type: string + enum: + - delete + - compact + - compact,delete + example: delete + log_flush_interval_messages: + description: >- + The number of messages accumulated on a log partition before + messages are flushed to disk + type: integer + minimum: 1 + maximum: 9223372036854776000 + example: 9223372036854776000 + log_flush_interval_ms: + description: >- + The maximum time in ms that a message in any topic is kept + in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms + is used + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 1000000 + log_index_interval_bytes: + description: >- + The interval with which Kafka adds an entry to the offset + index + type: integer + minimum: 0 + maximum: 104857600 + example: 4096 + log_index_size_max_bytes: + description: >- + The maximum size in bytes of the offset index + type: integer + minimum: 1048576 + maximum: 104857600 + example: 10485760 + log_message_downconversion_enable: + description: >- + This configuration controls whether down-conversion of + message formats is enabled to satisfy consume requests. + type: boolean + example: true + log_message_timestamp_type: + description: >- + Define whether the timestamp in the message is message + create time or log append time. + type: string + enum: + - CreateTime + - LogAppendTime + example: CreateTime + log_message_timestamp_difference_max_ms: + description: >- + The maximum difference allowed between the timestamp when + a broker receives a message and the timestamp specified in the message + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 1000000 + log_preallocate: + description: >- + Controls whether to preallocate a file when creating a new segment + type: boolean + example: false + log_retention_bytes: + description: >- + The maximum size of the log before deleting messages + type: integer + minimum: -1 + maximum: 9223372036854776000 + example: 1000000 + log_retention_hours: + description: >- + The number of hours to keep a log file before deleting it + type: integer + minimum: -1 + maximum: 2147483647 + example: 1000000 + log_retention_ms: + description: >- + The number of milliseconds to keep a log file before deleting + it (in milliseconds), If not set, the value in log.retention.minutes + is used. If set to -1, no time limit is applied. + type: integer + minimum: -1 + maximum: 9223372036854776000 + example: 100000000 + log_roll_jitter_ms: + description: >- + The maximum jitter to subtract from logRollTimeMillis (in + milliseconds). If not set, the value in log.roll.jitter.hours is used + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 10000000 + log_roll_ms: + description: >- + The maximum time before a new log segment is rolled out + (in milliseconds). + type: integer + minimum: 1 + maximum: 9223372036854776000 + example: 1000000 + log_segment_bytes: + description: >- + The maximum size of a single log file + type: integer + minimum: 10485760 + maximum: 1073741824 + example: 100000000 + log_segment_delete_delay_ms: + description: >- + The amount of time to wait before deleting a file from + the filesystem + type: integer + minimum: 0 + maximum: 3600000 + example: 60000 + auto_create_topics_enable: + description: >- + Enable auto creation of topics + type: boolean + example: true + min_insync_replicas: + description: >- + When a producer sets acks to 'all' (or '-1'), min_insync_replicas + specifies the minimum number of replicas that must acknowledge a write + for the write to be considered successful. + type: integer + minimum: 1 + maximum: 7 + example: 1 + num_partitions: + description: >- + Number of partitions for autocreated topics + type: integer + minimum: 1 + maximum: 1000 + example: 10 + default_replication_factor: + description: >- + Replication factor for autocreated topics + type: integer + minimum: 1 + maximum: 10 + example: 2 + replica_fetch_max_bytes: + description: >- + The number of bytes of messages to attempt to fetch for + each partition (defaults to 1048576). This is not an absolute maximum, + if the first record batch in the first non-empty partition of the + fetch is larger than this value, the record batch will still be returned + to ensure that progress can be made. + type: integer + minimum: 1048576 + maximum: 104857600 + example: 2097152 + replica_fetch_response_max_bytes: + description: >- + Maximum bytes expected for the entire fetch response (defaults + to 10485760). Records are fetched in batches, and if the first record + batch in the first non-empty partition of the fetch is larger than + this value, the record batch will still be returned to ensure that + progress can be made. As such, this is not an absolute maximum. + type: integer + minimum: 10485760 + maximum: 1048576000 + example: 20971520 + max_connections_per_ip: + description: >- + The maximum number of connections allowed from each ip + address (defaults to 2147483647). + type: integer + minimum: 256 + maximum: 2147483647 + example: 512 + producer_purgatory_purge_interval_requests: + description: >- + The purge interval (in number of requests) of the producer + request purgatory (defaults to 1000). + type: integer + minimum: 10 + maximum: 10000 + example: 100 + socket_request_max_bytes: + description: >- + The maximum number of bytes in a socket request (defaults + to 104857600). + type: integer + minimum: 10485760 + maximum: 209715200 + example: 20971520 + transaction_state_log_segment_bytes: + description: >- + The transaction topic segment bytes should be kept relatively + small in order to facilitate faster log compaction and cache loads + (defaults to 104857600 (100 mebibytes)). + type: integer + minimum: 1048576 + maximum: 2147483647 + example: 104857600 + transaction_remove_expired_transaction_cleanup_interval_ms: + description: >- + The interval at which to remove transactions that have + expired due to transactional.id.expiration.ms passing (defaults to + 3600000 (1 hour)). + type: integer + minimum: 600000 + maximum: 3600000 + example: 3600000 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mongo_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mongo_advanced_config.yml new file mode 100644 index 000000000..a6ca81d9d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mongo_advanced_config.yml @@ -0,0 +1,52 @@ +type: object + +properties: + default_read_concern: + description: >- + Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may + or may not have been acknowledged by all nodes in the replicaset depending on this value. + Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/). + type: string + enum: [local, available, majority] + default: local + example: local + default_write_concern: + description: >- + Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority` + or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. + Setting to `0` will request no acknowledgement of the write operation. + Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/). + type: string + default: majority + example: majority + transaction_lifetime_limit_seconds: + description: >- + Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be + aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least + once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* + Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds). + type: integer + minimum: 1 + default: 60 + example: 100 + slow_op_threshold_ms: + description: >- + Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. + Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. + *Changing this parameter will lead to a restart of the MongoDB service.* + Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs). + type: integer + minimum: 0 + default: 100 + example: 200 + verbosity: + description: >- + The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. + 0 includes informational messages while 1...5 increases the level to include debug messages. + *Changing this parameter will lead to a restart of the MongoDB service.* + Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity). + type: integer + minimum: 0 + maximum: 5 + default: 0 + example: 3 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml new file mode 100644 index 000000000..5b3c776f6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml @@ -0,0 +1,256 @@ +type: object + +properties: + backup_hour: + description: >- + The hour of day (in UTC) when backup for the service starts. New backup + only starts if previous backup has already completed. + minimum: 0 + maximum: 23 + type: integer + example: 3 + backup_minute: + description: >- + The minute of the backup hour when backup for the service starts. New backup + only starts if previous backup has already completed. + minimum: 0 + maximum: 59 + type: integer + example: 30 + sql_mode: + description: >- + Global SQL mode. If empty, uses MySQL server defaults. + Must only include uppercase alphabetic characters, underscores, and commas. + type: string + pattern: ^[A-Z_]*(,[A-Z_]+)*$ + example: ANSI,TRADITIONAL + maxLength: 1024 + connect_timeout: + description: >- + The number of seconds that the mysqld server waits for a connect packet + before responding with bad handshake. + type: integer + minimum: 2 + maximum: 3600 + example: 10 + default_time_zone: + description: >- + Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a + time zone name (EST), or 'SYSTEM' to use the MySQL server default. + type: string + example: '+03:00' + minLength: 2 + maxLength: 100 + group_concat_max_len: + description: >- + The maximum permitted result length, in bytes, for the GROUP_CONCAT() + function. + type: integer + minimum: 4 + maximum: 18446744073709552000 + example: 1024 + information_schema_stats_expiry: + description: The time, in seconds, before cached statistics expire. + type: integer + minimum: 900 + maximum: 31536000 + example: 86400 + innodb_ft_min_token_size: + description: The minimum length of words that an InnoDB FULLTEXT index stores. + type: integer + minimum: 0 + maximum: 16 + example: 3 + innodb_ft_server_stopword_table: + description: >- + The InnoDB FULLTEXT index stopword + list for all InnoDB tables. + type: string + pattern: ^.+/.+$ + example: db_name/table_name + maxLength: 1024 + innodb_lock_wait_timeout: + description: >- + The time, in seconds, that an InnoDB transaction waits for a row lock. + before giving up. + type: integer + minimum: 1 + maximum: 3600 + example: 50 + innodb_log_buffer_size: + description: >- + The size of the buffer, in bytes, that InnoDB uses to write to the log files. + on disk. + type: integer + minimum: 1048576 + maximum: 4294967295 + example: 16777216 + innodb_online_alter_log_max_size: + description: >- + The upper limit, in bytes, of the size of the temporary log files used + during online DDL operations for InnoDB tables. + type: integer + minimum: 65536 + maximum: 1099511627776 + example: 134217728 + innodb_print_all_deadlocks: + description: >- + When enabled, records information about all deadlocks in InnoDB user transactions + in the error log. Disabled by default. + type: boolean + example: true + innodb_rollback_on_timeout: + description: >- + When enabled, transaction timeouts cause InnoDB to abort and roll back + the entire transaction. + type: boolean + example: true + interactive_timeout: + description: >- + The time, in seconds, the server waits for activity on an interactive. + connection before closing it. + type: integer + minimum: 30 + maximum: 604800 + example: 3600 + internal_tmp_mem_storage_engine: + description: The storage engine for in-memory internal temporary tables. + type: string + enum: + - TempTable + - MEMORY + example: TempTable + net_read_timeout: + description: >- + The time, in seconds, to wait for more data from an existing connection. + aborting the read. + type: integer + minimum: 1 + maximum: 3600 + example: 30 + net_write_timeout: + description: >- + The number of seconds to wait for a block to be written to a connection + before aborting the write. + type: integer + minimum: 1 + maximum: 3600 + example: 30 + sql_require_primary_key: + description: >- + Require primary key to be defined for new tables or old tables modified + with ALTER TABLE and fail if missing. It is recommended to always have + primary keys because various functionality may break if any large table is + missing them. + type: boolean + example: true + wait_timeout: + description: >- + The number of seconds the server waits for activity on a noninteractive + connection before closing it. + type: integer + minimum: 1 + maximum: 2147483 + example: 28800 + max_allowed_packet: + description: >- + The size of the largest message, in bytes, that can be received by the server. + Default is 67108864 (64M). + type: integer + minimum: 102400 + maximum: 1073741824 + example: 67108864 + max_heap_table_size: + description: >- + The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. + Default is 16777216 (16M) + type: integer + minimum: 1048576 + maximum: 1073741824 + example: 16777216 + sort_buffer_size: + description: >- + The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. + (256K). + type: integer + minimum: 32768 + maximum: 1073741824 + example: 262144 + tmp_table_size: + description: >- + The maximum size, in bytes, of internal in-memory tables. Also set + max_heap_table_size. Default is 16777216 (16M). + type: integer + minimum: 1048576 + maximum: 1073741824 + example: 16777216 + slow_query_log: + description: >- + When enabled, captures slow queries. When disabled, also + truncates the mysql.slow_log table. Default is false. + type: boolean + example: true + long_query_time: + description: >- + The time, in seconds, for a query to take to execute before + being captured by slow_query_logs. Default is 10 seconds. + type: number + minimum: 0 + maximum: 3600 + example: 10 + binlog_retention_period: + description: >- + The minimum amount of time, in seconds, to keep binlog entries before deletion. + This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector. + type: number + minimum: 600 + maximum: 86400 + example: 600 + innodb_change_buffer_max_size: + description: >- + Specifies the maximum size of the InnoDB change buffer as a percentage of the buffer pool. + type: integer + minimum: 0 + maximum: 50 + example: 25 + innodb_flush_neighbors: + description: >- + Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent. + - 0 — disables this functionality, dirty pages in the same extent are not flushed. + - 1 — flushes contiguous dirty pages in the same extent. + - 2 — flushes dirty pages in the same extent. + type: integer + enum: + - 0 + - 1 + - 2 + example: 0 + innodb_read_io_threads: + description: >- + The number of I/O threads for read operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service. + type: integer + minimum: 1 + maximum: 64 + example: 16 + innodb_write_io_threads: + description: >- + The number of I/O threads for write operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service. + type: integer + minimum: 1 + maximum: 64 + example: 16 + innodb_thread_concurrency: + description: >- + Defines the maximum number of threads permitted inside of InnoDB. A value of 0 (the default) is interpreted as infinite concurrency (no limit). This variable is intended for performance + tuning on high concurrency systems. + type: integer + minimum: 0 + maximum: 1000 + example: 0 + net_buffer_length: + description: >- + Start sizes of connection buffer and result buffer, must be multiple of 1024. Changing this parameter will lead to a restart of the MySQL service. + type: integer + minimum: 1024 + maximum: 1048576 + example: 4096 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml new file mode 100644 index 000000000..b72e7b1de --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/opensearch_advanced_config.yml @@ -0,0 +1,284 @@ +type: object + +properties: + http_max_content_length_bytes: + description: >- + Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. + type: integer + example: 100000000 + minimum: 1 + maximum: 2147483647 + default: 100000000 + http_max_header_size_bytes: + description: >- + Maximum size of allowed headers, in bytes. + type: integer + example: 8192 + minimum: 1024 + maximum: 262144 + default: 8192 + http_max_initial_line_length_bytes: + description: >- + Maximum length of an HTTP URL, in bytes. + type: integer + example: 4096 + minimum: 1024 + maximum: 65536 + default: 4096 + indices_query_bool_max_clause_count: + description: >- + Maximum number of clauses Lucene BooleanQuery can have. + Only increase it if necessary, as it may cause performance issues. + type: integer + example: 1024 + minimum: 64 + maximum: 4096 + default: 1024 + indices_fielddata_cache_size_percentage: + description: >- + Maximum amount of heap memory used for field data cache, expressed as a percentage. + Decreasing the value too much will increase overhead of loading field data. + Increasing the value too much will decrease amount of heap available for other operations. + type: integer + example: 3 + minimum: 3 + maximum: 100 + indices_memory_index_buffer_size_percentage: + description: >- + Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. + Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. + type: integer + example: 10 + minimum: 3 + maximum: 40 + default: 10 + indices_memory_min_index_buffer_size_mb: + description: >- + Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. + Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. + type: integer + example: 48 + minimum: 3 + maximum: 2048 + default: 48 + indices_memory_max_index_buffer_size_mb: + description: >- + Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. + Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. + The default is unbounded. + type: integer + example: 48 + minimum: 3 + maximum: 2048 + indices_queries_cache_size_percentage: + description: >- + Maximum amount of heap used for query cache. + Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. + type: integer + example: 10 + minimum: 3 + maximum: 40 + default: 10 + indices_recovery_max_mb_per_sec: + description: >- + Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. + Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). + type: integer + example: 40 + minimum: 40 + maximum: 400 + default: 40 + indices_recovery_max_concurrent_file_chunks: + description: >- + Maximum number of file chunks sent in parallel for each recovery. + type: integer + example: 2 + minimum: 2 + maximum: 5 + default: 2 + thread_pool_search_size: + description: >- + Number of workers in the search operation thread pool. + Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + type: integer + example: 1 + minimum: 1 + maximum: 128 + thread_pool_search_throttled_size: + description: >- + Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. + Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + type: integer + example: 1 + minimum: 1 + maximum: 128 + thread_pool_get_size: + description: >- + Number of workers in the get operation thread pool. + Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + type: integer + example: 1 + minimum: 1 + maximum: 128 + thread_pool_analyze_size: + description: >- + Number of workers in the analyze operation thread pool. + Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + type: integer + example: 1 + minimum: 1 + maximum: 128 + thread_pool_write_size: + description: >- + Number of workers in the write operation thread pool. + Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + type: integer + example: 1 + minimum: 1 + maximum: 128 + thread_pool_force_merge_size: + description: >- + Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. + Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. + type: integer + example: 1 + minimum: 1 + maximum: 128 + thread_pool_search_queue_size: + description: >- + Size of queue for operations in the search thread pool. + type: integer + example: 10 + minimum: 10 + maximum: 2000 + thread_pool_search_throttled_queue_size: + description: >- + Size of queue for operations in the search throttled thread pool. + type: integer + example: 10 + minimum: 10 + maximum: 2000 + thread_pool_get_queue_size: + description: >- + Size of queue for operations in the get thread pool. + type: integer + example: 10 + minimum: 10 + maximum: 2000 + thread_pool_analyze_queue_size: + description: >- + Size of queue for operations in the analyze thread pool. + type: integer + example: 10 + minimum: 10 + maximum: 2000 + thread_pool_write_queue_size: + description: >- + Size of queue for operations in the write thread pool. + type: integer + example: 10 + minimum: 10 + maximum: 2000 + ism_enabled: + description: >- + Specifies whether ISM is enabled or not. + type: boolean + example: true + default: true + ism_history_enabled: + description: >- + Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. + type: boolean + example: true + default: true + ism_history_max_age_hours: + description: >- + Maximum age before rolling over the audit history index, in hours. + type: integer + example: 24 + minimum: 1 + maximum: 2147483647 + default: 24 + ism_history_max_docs: + description: >- + Maximum number of documents before rolling over the audit history index. + type: integer + example: 2500000 + minimum: 1 + maximum: 9223372036854776000 + default: 2500000 + ism_history_rollover_check_period_hours: + description: >- + The time between rollover checks for the audit history index, in hours. + type: integer + example: 8 + minimum: 1 + maximum: 2147483647 + default: 8 + ism_history_rollover_retention_period_days: + description: >- + Length of time long audit history indices are kept, in days. + type: integer + example: 30 + minimum: 1 + maximum: 2147483647 + default: 30 + search_max_buckets: + description: >- + Maximum number of aggregation buckets allowed in a single response. + type: integer + example: 10000 + minimum: 1 + maximum: 1000000 + default: 10000 + action_auto_create_index_enabled: + description: >- + Specifices whether to allow automatic creation of indices. + type: boolean + example: true + default: true + enable_security_audit: + description: >- + Specifies whether to allow security audit logging. + type: boolean + example: false + default: false + action_destructive_requires_name: + description: >- + Specifies whether to require explicit index names when deleting indices. + type: boolean + example: false + cluster_max_shards_per_node: + description: >- + Maximum number of shards allowed per data node. + type: integer + example: 100 + minimum: 100 + maximum: 10000 + override_main_response_version: + description: >- + Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. + type: boolean + example: false + default: false + script_max_compilations_rate: + description: >- + Limits the number of inline script compilations within a period of time. Default is use-context + type: string + example: 75/5m + default: use-context + cluster_routing_allocation_node_concurrent_recoveries: + description: >- + Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node . + type: integer + example: 2 + minimum: 2 + maximum: 16 + default: 2 + reindex_remote_whitelist: + description: >- + Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart. + type: array + items: + type: string + example: ["255.255.223.233:9200", "222.33.222.222:6300"] \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/pgbouncer_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/pgbouncer_advanced_config.yml new file mode 100644 index 000000000..a7e4b8821 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/pgbouncer_advanced_config.yml @@ -0,0 +1,78 @@ +type: object +description: PGBouncer connection pooling settings + +properties: + server_reset_query_always: + description: Run server_reset_query (DISCARD ALL) in all pooling modes. + type: boolean + example: false + ignore_startup_parameters: + description: List of parameters to ignore when given in startup packet. + type: array + example: + - extra_float_digits + - search_path + items: + description: Enum of parameters to ignore when given in startup packet. + type: string + enum: + - extra_float_digits + - search_path + maxItems: 32 + min_pool_size: + description: >- + If current server connections are below this number, adds more. Improves + behavior when usual load comes suddenly back after period of total + inactivity. The value is effectively capped at the pool size. + type: integer + minimum: 0 + maximum: 10000 + example: 1 + server_lifetime: + description: >- + The pooler closes any unused server connection that has been + connected longer than this amount of seconds. + type: integer + minimum: 60 + maximum: 86400 + example: 3600 + server_idle_timeout: + description: >- + Drops server connections if they have been idle more than this many seconds. + If 0, timeout is disabled. + type: integer + minimum: 0 + maximum: 86400 + example: 600 + autodb_pool_size: + description: >- + If non-zero, automatically creates a pool of that size per user when + a pool doesn't exist. + type: integer + minimum: 0 + maximum: 10000 + example: 1 + autodb_pool_mode: + enum: + - session + - transaction + - statement + example: session + description: PGBouncer pool mode + type: string + autodb_max_db_connections: + description: >- + Only allows a maximum this many server connections per database + (regardless of user). If 0, allows unlimited connections. + type: integer + minimum: 0 + maximum: 2147483647 + example: 1 + autodb_idle_timeout: + description: >- + If the automatically-created database pools have been unused this many + seconds, they are freed. If 0, timeout is disabled. + type: integer + minimum: 0 + maximum: 86400 + example: 3600 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml new file mode 100644 index 000000000..dc77b86cc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/postgres_advanced_config.yml @@ -0,0 +1,409 @@ +type: object + +properties: + autovacuum_freeze_max_age: + description: >- + Specifies the maximum age (in transactions) that a table's + pg_class.relfrozenxid field can attain before a VACUUM operation is forced + to prevent transaction ID wraparound within the table. Note that the + system will launch autovacuum processes to prevent wraparound even when + autovacuum is otherwise disabled. This parameter will cause the server to + be restarted. + type: integer + minimum: 200000000 + maximum: 1500000000 + example: 200000000 + autovacuum_max_workers: + description: >- + Specifies the maximum number of autovacuum processes (other than the + autovacuum launcher) that may be running at any one time. The default is + three. This parameter can only be set at server start. + type: integer + minimum: 1 + maximum: 20 + example: 5 + autovacuum_naptime: + description: >- + Specifies the minimum delay, in seconds, between autovacuum runs on any given database. + The default is one minute. + type: integer + minimum: 0 + maximum: 86400 + example: 43200 + autovacuum_vacuum_threshold: + description: >- + Specifies the minimum number of updated or deleted tuples needed to + trigger a VACUUM in any one table. The default is 50 tuples. + type: integer + minimum: 0 + maximum: 2147483647 + example: 50 + autovacuum_analyze_threshold: + description: >- + Specifies the minimum number of inserted, updated, or deleted tuples needed + to trigger an ANALYZE in any one table. The default is 50 tuples. + type: integer + minimum: 0 + maximum: 2147483647 + example: 50 + autovacuum_vacuum_scale_factor: + description: >- + Specifies a fraction, in a decimal value, of the table size to add to + autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The + default is 0.2 (20% of table size). + type: number + minimum: 0 + maximum: 1 + example: 0.2 + autovacuum_analyze_scale_factor: + description: >- + Specifies a fraction, in a decimal value, of the table size to add to + autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. + The default is 0.2 (20% of table size). + type: number + minimum: 0 + maximum: 1 + example: 0.2 + autovacuum_vacuum_cost_delay: + description: >- + Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM + operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds. + type: integer + minimum: -1 + maximum: 100 + example: 20 + autovacuum_vacuum_cost_limit: + description: >- + Specifies the cost limit value that will be used in automatic VACUUM + operations. If -1 is specified (which is the default), the regular + vacuum_cost_limit value will be used. + type: integer + minimum: -1 + maximum: 10000 + example: -1 + backup_hour: + description: >- + The hour of day (in UTC) when backup for the service starts. New backup + only starts if previous backup has already completed. + minimum: 0 + maximum: 23 + type: integer + example: 3 + backup_minute: + description: >- + The minute of the backup hour when backup for the service starts. New backup is + only started if previous backup has already completed. + minimum: 0 + maximum: 59 + type: integer + example: 30 + bgwriter_delay: + description: >- + Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms. + type: integer + minimum: 10 + maximum: 10000 + example: 200 + bgwriter_flush_after: + description: >- + The amount of kilobytes that need to be written by the background writer before + attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. + Setting of 0 disables forced writeback. + type: integer + minimum: 0 + maximum: 2048 + example: 512 + bgwriter_lru_maxpages: + description: >- + The maximum number of buffers that the background writer can write. + Setting this to zero disables background writing. + Default is 100. + type: integer + minimum: 0 + maximum: 1073741823 + example: 100 + bgwriter_lru_multiplier: + description: >- + The average recent need for new buffers is multiplied by + bgwriter_lru_multiplier to arrive at an estimate of the number that will + be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 + represents a “just in time” policy of writing exactly the number of + buffers predicted to be needed. Larger values provide some cushion against + spikes in demand, while smaller values intentionally leave writes to be + done by server processes. The default is 2.0. + type: number + minimum: 0 + maximum: 10 + example: 2 + deadlock_timeout: + description: >- + The amount of time, in milliseconds, to wait on a lock before + checking to see if there is a deadlock condition. + type: integer + minimum: 500 + maximum: 1800000 + example: 1000 + default_toast_compression: + description: >- + Specifies the default TOAST compression method for values of compressible + columns (the default is lz4). + type: string + enum: + - lz4 + - pglz + example: lz4 + idle_in_transaction_session_timeout: + description: Time out sessions with open transactions after this number of milliseconds + type: integer + minimum: 0 + maximum: 604800000 + example: 10000 + jit: + description: Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT). + type: boolean + example: true + log_autovacuum_min_duration: + description: >- + Causes each action executed by autovacuum to be logged if it ran for at + least the specified number of milliseconds. Setting this to zero logs all + autovacuum actions. Minus-one (the default) disables logging autovacuum + actions. + type: integer + minimum: -1 + maximum: 2147483647 + example: -1 + log_error_verbosity: + description: >- + Controls the amount of detail written in the server log for each message + that is logged. + type: string + enum: + - TERSE + - DEFAULT + - VERBOSE + example: VERBOSE + log_line_prefix: + description: >- + Selects one of the available log-formats. These can support popular + log analyzers like pgbadger, pganalyze, etc. + type: string + enum: + - pid=%p,user=%u,db=%d,app=%a,client=%h + - "%m [%p] %q[user=%u,db=%d,app=%a]" + - "%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h" + example: pid=%p,user=%u,db=%d,app=%a,client=%h + log_min_duration_statement: + description: >- + Log statements that take more than this number of milliseconds to run. If -1, + disables. + type: integer + minimum: -1 + maximum: 86400000 + example: -1 + max_files_per_process: + description: PostgreSQL maximum number of files that can be open per process. + type: integer + minimum: 1000 + maximum: 4096 + example: 2048 + max_prepared_transactions: + description: PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value. + type: integer + minimum: 0 + maximum: 10000 + example: 20 + max_pred_locks_per_transaction: + description: PostgreSQL maximum predicate locks per transaction. + type: integer + minimum: 64 + maximum: 640 + example: 128 + max_locks_per_transaction: + description: PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value. + type: integer + minimum: 64 + maximum: 6400 + example: 128 + max_stack_depth: + description: Maximum depth of the stack in bytes. + type: integer + minimum: 2097152 + maximum: 6291456 + example: 2097152 + max_standby_archive_delay: + description: Max standby archive delay in milliseconds. + type: integer + minimum: 1 + maximum: 43200000 + example: 43200 + max_standby_streaming_delay: + description: Max standby streaming delay in milliseconds. + type: integer + minimum: 1 + maximum: 43200000 + example: 43200 + max_replication_slots: + description: PostgreSQL maximum replication slots. + type: integer + minimum: 8 + maximum: 64 + example: 16 + max_logical_replication_workers: + description: >- + PostgreSQL maximum logical replication workers (taken from the pool of + max_parallel_workers). + type: integer + minimum: 4 + maximum: 64 + example: 16 + max_parallel_workers: + description: >- + Sets the maximum number of workers that the system can support for + parallel queries. + type: integer + minimum: 0 + maximum: 96 + example: 12 + max_parallel_workers_per_gather: + description: >- + Sets the maximum number of workers that can be started by a single Gather + or Gather Merge node. + type: integer + minimum: 0 + maximum: 96 + example: 16 + max_worker_processes: + description: >- + Sets the maximum number of background processes that the system can + support. Once increased, this parameter cannot be lowered from its set value. + type: integer + minimum: 8 + maximum: 96 + example: 16 + pg_partman_bgw.role: + type: string + pattern: ^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$ + maxLength: 64 + example: myrolename + description: >- + Controls which role to use for pg_partman's scheduled background tasks. + Must consist of alpha-numeric characters, dots, underscores, or dashes. May + not start with dash or dot. Maximum of 64 characters. + pg_partman_bgw.interval: + description: Sets the time interval to run pg_partman's scheduled tasks. + type: integer + minimum: 3600 + maximum: 604800 + example: 3600 + pg_stat_statements.track: + description: >- + Controls which statements are counted. Specify 'top' to track top-level + statements (those issued directly by clients), 'all' to also track nested + statements (such as statements invoked within functions), or 'none' to + disable statement statistics collection. The default value is top. + type: string + enum: + - all + - top + - none + example: all + temp_file_limit: + description: PostgreSQL temporary file limit in KiB. If -1, sets to unlimited. + type: integer + example: 5000000 + minimum: -1 + maximum: 2147483647 + timezone: + description: PostgreSQL service timezone + type: string + example: Europe/Helsinki + maxLength: 64 + track_activity_query_size: + description: >- + Specifies the number of bytes reserved to track the currently executing + command for each active session. + type: integer + example: 1024 + minimum: 1024 + maximum: 10240 + track_commit_timestamp: + description: Record commit time of transactions. + type: string + enum: + - 'off' + - 'on' + example: 'off' + track_functions: + description: Enables tracking of function call counts and time used. + type: string + enum: + - all + - pl + - none + example: all + track_io_timing: + description: >- + Enables timing of database I/O calls. This parameter is off by default, + because it will repeatedly query the operating system for the current + time, which may cause significant overhead on some platforms. + type: string + enum: + - 'off' + - 'on' + example: 'off' + max_wal_senders: + description: PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value. + type: integer + minimum: 20 + maximum: 64 + example: 32 + wal_sender_timeout: + description: >- + Terminate replication connections that are inactive for longer than this + amount of time, in milliseconds. Setting this value to zero disables the + timeout. Must be either 0 or between 5000 and 10800000. + type: integer + minimum: 0 + maximum: 10800000 + example: 60000 + wal_writer_delay: + description: >- + WAL flush interval in milliseconds. Note that setting this value to lower + than the default 200ms may negatively impact performance + type: integer + minimum: 10 + maximum: 200 + example: 50 + shared_buffers_percentage: + description: >- + Percentage of total RAM that the database server uses for shared memory buffers. + Valid range is 20-60 (float), which corresponds to 20% - 60%. + This setting adjusts the shared_buffers configuration value. + type: number + minimum: 20.0 + maximum: 60.0 + example: 41.5 + pgbouncer: + $ref: './pgbouncer_advanced_config.yml' + work_mem: + description: >- + The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. + Default is 1MB + 0.075% of total RAM (up to 32MB). + type: integer + minimum: 1 + maximum: 1024 + example: 4 + timescaledb: + $ref: './timescaledb_advanced_config.yml' + synchronous_replication: + description: Synchronous replication type. Note that the service plan also needs to support synchronous replication. + type: string + example: "off" + enum: + - 'off' + - 'quorum' + stat_monitor_enable: + description: >- + Enable the pg_stat_monitor extension. Enabling this extension will cause the cluster to be restarted. When this extension is enabled, pg_stat_statements results for utility commands are unreliable. + type: boolean + example: false diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml new file mode 100644 index 000000000..9e418eb60 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml @@ -0,0 +1,102 @@ +type: object + +properties: + redis_maxmemory_policy: + $ref: '../eviction_policy_model.yml' + redis_pubsub_client_output_buffer_limit: + description: >- + Set output buffer limit for pub / sub clients in MB. The value is the hard + limit, the soft limit is 1/4 of the hard limit. When setting the limit, be + mindful of the available memory in the selected service plan. + type: integer + minimum: 32 + maximum: 512 + example: 64 + redis_number_of_databases: + type: integer + minimum: 1 + maximum: 128 + description: >- + Set number of redis databases. Changing this will cause a restart of redis + service. + example: 16 + redis_io_threads: + description: Redis IO thread count + type: integer + minimum: 1 + maximum: 32 + example: 1 + redis_lfu_log_factor: + description: >- + Counter logarithm factor for volatile-lfu and allkeys-lfu + maxmemory-policies + type: integer + minimum: 0 + maximum: 100 + default: 10 + example: 10 + redis_lfu_decay_time: + description: LFU maxmemory-policy counter decay time in minutes + type: integer + minimum: 1 + maximum: 120 + default: 1 + example: 1 + redis_ssl: + description: Require SSL to access Redis + type: boolean + default: true + example: true + redis_timeout: + description: Redis idle connection timeout in seconds + type: integer + minimum: 0 + maximum: 31536000 + default: 300 + example: 300 + redis_notify_keyspace_events: + description: |2- + Set notify-keyspace-events option. Requires at least `K` or `E` and accepts any combination of the following options. Setting the parameter to `""` disables notifications. + - `K` — Keyspace events + - `E` — Keyevent events + - `g` — Generic commands (e.g. `DEL`, `EXPIRE`, `RENAME`, ...) + - `$` — String commands + - `l` — List commands + - `s` — Set commands + - `h` — Hash commands + - `z` — Sorted set commands + - `t` — Stream commands + - `d` — Module key type events + - `x` — Expired events + - `e` — Evicted events + - `m` — Key miss events + - `n` — New key events + - `A` — Alias for `"g$lshztxed"` + type: string + pattern: ^[KEg\$lshzxeA]*$ + default: '' + maxLength: 32 + example: K + redis_persistence: + type: string + enum: + - 'off' + - rdb + description: >- + When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key + is changed. Also RDB dumps are done according to backup schedule for + backup purposes. When persistence is 'off', no RDB dumps and backups are + done, so data can be lost at any moment if service is restarted for any + reason, or if service is powered off. Also service can't be forked. + example: rdb + redis_acl_channels_default: + type: string + enum: + - allchannels + - resetchannels + description: >- + Determines default pub/sub channels' ACL for new users if ACL is not + supplied. When this option is not defined, all_channels is assumed to keep + backward compatibility. This option doesn't affect Redis configuration + acl-pubsub-default. + example: allchannels diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/timescaledb_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/timescaledb_advanced_config.yml new file mode 100644 index 000000000..dff9c8d8e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/timescaledb_advanced_config.yml @@ -0,0 +1,12 @@ +type: object +description: TimescaleDB extension configuration values + +properties: + max_background_workers: + description: >- + The number of background workers for timescaledb operations. + Set to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. + type: integer + minimum: 1 + maximum: 4096 + example: 8 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml index 563bf5831..15f391a51 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml @@ -24,7 +24,7 @@ properties: description: >- A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, - "kafka" for Kafka and "opensearch" for OpenSearch. OpenSearch is in closed beta. To request access, [contact support](https://cloudsupport.digitalocean.com). + "kafka" for Kafka, and "opensearch" for OpenSearch. version: type: string example: '8' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml index 61282ddbf..4143b1ba2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml @@ -3,8 +3,9 @@ type: object properties: config: anyOf: - - $ref: './mysql.yml' - - $ref: './postgres.yml' - - $ref: './redis.yml' - - $ref: './mongo.yml' - - $ref: './kafka.yml' + - $ref: './advanced_config/mysql_advanced_config.yml' + - $ref: './advanced_config/postgres_advanced_config.yml' + - $ref: './advanced_config/redis_advanced_config.yml' + - $ref: './advanced_config/mongo_advanced_config.yml' + - $ref: './advanced_config/kafka_advanced_config.yml' + - $ref: './advanced_config/opensearch_advanced_config.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml index 9c86dff9f..3f5755d83 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml @@ -20,7 +20,6 @@ properties: the cluster. size: type: string - writeOnly: true example: db-s-2vcpu-4gb description: >- A slug identifier representing the size of the node for the read-only diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/elasticsearch_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/elasticsearch_logsink.yml new file mode 100644 index 000000000..fb034827f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/elasticsearch_logsink.yml @@ -0,0 +1,37 @@ +type: object +properties: + url: + type: string + example: https://user:passwd@192.168.0.1:9200 + description: >- + Elasticsearch connection URL + index_prefix: + type: string + example: elastic-logs + description: Elasticsearch index prefix + index_days_max: + type: integer + default: 7 + example: 5 + maximum: 10000 + minimum: 1 + description: >- + Maximum number of days of logs to keep + timeout: + type: number + format: float + example: 10.0 + default: 10.0 + minimum: 10.0 + maximum: 120.0 + description: >- + Elasticsearch request timeout limit + ca: + type: string + example: -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + description: >- + PEM encoded CA certificate + +required: + - url + - index_prefix \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/opensearch_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/opensearch_logsink.yml new file mode 100644 index 000000000..834a786dd --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/opensearch_logsink.yml @@ -0,0 +1,37 @@ +type: object +properties: + url: + type: string + example: https://user:passwd@192.168.0.1:9200 + description: >- + Opensearch connection URL + index_prefix: + type: string + example: opensearch-logs + description: Opensearch index prefix + index_days_max: + type: integer + default: 7 + example: 5 + maximum: 10000 + minimum: 1 + description: >- + Maximum number of days of logs to keep + timeout: + type: number + format: float + example: 10.0 + default: 10.0 + minimum: 10.0 + maximum: 120.0 + description: >- + Opensearch request timeout limit + ca: + type: string + example: -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + description: >- + PEM encoded CA certificate + +required: + - url + - index_prefix \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml new file mode 100644 index 000000000..487ca7dd8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml @@ -0,0 +1,59 @@ +type: object +properties: + server: + type: string + example: 192.168.0.1 + description: >- + DNS name or IPv4 address of the rsyslog server + port: + type: integer + example: 514 + maximum: 65535 + description: The internal port on which the rsyslog server is listening + tls: + type: boolean + example: false + description: >- + Use TLS (as the messages are not filtered and may contain sensitive information, it is highly recommended to set this to true if the remote server supports it) + format: + type: string + enum: + - rfc5424 + - rfc3164 + - custom + example: rfc5424 + description: >- + Message format used by the server, this can be either rfc3164 (the old BSD style message format), `rfc5424` (current syslog message format) or custom + logline: + type: string + example: <%pri%>%timestamp:::date-rfc3339% %HOSTNAME% %app-name% %msg% + description: | + Conditional (required if `format` == `custom`). + + Syslog log line template for a custom format, supporting limited rsyslog style templating (using `%tag%`). Supported tags are: `HOSTNAME`, `app-name`, `msg`, `msgid`, `pri`, `procid`, `structured-data`, `timestamp` and `timestamp:::date-rfc3339`. + sd: + type: string + example: TOKEN tag="LiteralValue" + description: >- + content of the structured data block of rfc5424 message + ca: + type: string + example: -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + description: >- + PEM encoded CA certificate + key: + type: string + example: -----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n + description: >- + (PEM format) client key if the server requires client authentication + cert: + type: string + example: -----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n + description: >- + (PEM format) client cert to use + +required: + - server + - port + - tls + - format \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml new file mode 100644 index 000000000..95eb8e571 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml @@ -0,0 +1,15 @@ +type: object + +properties: + sink_name: + type: string + description: The name of the Logsink + example: prod-logsink + + sink_type: + type: string + enum: + - rsyslog + - elasticsearch + - opensearch + example: rsyslog diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base_verbose.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base_verbose.yml new file mode 100644 index 000000000..a3f21ea4f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base_verbose.yml @@ -0,0 +1,20 @@ +type: object + +properties: + sink_id: + type: string + example: dfcc9f57d86bf58e321c2c6c31c7a971be244ac7 + description: A unique identifier for Logsink + + sink_name: + type: string + description: The name of the Logsink + example: prod-logsink + + sink_type: + type: string + enum: + - rsyslog + - elasticsearch + - opensearch + example: rsyslog diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml new file mode 100644 index 000000000..3a44034f5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml @@ -0,0 +1,10 @@ +type: object + +allOf: +- $ref: './logsink_base.yml' +- properties: + config: + anyOf: + - $ref: './logsink/rsyslog_logsink.yml' + - $ref: './logsink/elasticsearch_logsink.yml' + - $ref: './logsink/opensearch_logsink.yml' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml new file mode 100644 index 000000000..2174051d8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml @@ -0,0 +1,11 @@ +type: object + +properties: + config: + anyOf: + - $ref: './logsink/rsyslog_logsink.yml' + - $ref: './logsink/elasticsearch_logsink.yml' + - $ref: './logsink/opensearch_logsink.yml' + +required: + - config \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml new file mode 100644 index 000000000..2215096a6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml @@ -0,0 +1,16 @@ +type: object + +allOf: + - $ref: "./logsink_base_verbose.yml" + - properties: + config: + anyOf: + - $ref: './logsink/rsyslog_logsink.yml' + - $ref: './logsink/elasticsearch_logsink.yml' + - $ref: './logsink/opensearch_logsink.yml' + example: + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc5424 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml index 9b8e95c60..f0ffe5ada 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml @@ -70,3 +70,12 @@ kafka_topic_name: example: customer-events schema: type: string + +logsink_id: + in: path + name: logsink_id + description: A unique identifier for a logsink of a database cluster + required: true + example: 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + schema: + type: string \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml index 27e469e9c..6b0f36817 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml @@ -15,9 +15,12 @@ content: properties: config: anyOf: - - $ref: '../models/mysql.yml' - - $ref: '../models/postgres.yml' - - $ref: '../models/redis.yml' + - $ref: '../models/advanced_config/mysql_advanced_config.yml' + - $ref: '../models/advanced_config/postgres_advanced_config.yml' + - $ref: '../models/advanced_config/redis_advanced_config.yml' + - $ref: '../models/advanced_config/kafka_advanced_config.yml' + - $ref: '../models/advanced_config/opensearch_advanced_config.yml' + - $ref: '../models/advanced_config/mongo_advanced_config.yml' required: - config example: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml new file mode 100644 index 000000000..c598f90e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml @@ -0,0 +1,49 @@ +description: A JSON object with a key of `sink`. + +headers: + ratelimit-limit: + $ref: "../../../shared/headers.yml#/ratelimit-limit" + ratelimit-remaining: + $ref: "../../../shared/headers.yml#/ratelimit-remaining" + ratelimit-reset: + $ref: "../../../shared/headers.yml#/ratelimit-reset" + +content: + application/json: + schema: + allOf: + - $ref: "../models/logsink_verbose.yml" + required: + - sink_id + - sink_name + - sink_type + - config + examples: + Create an opensearch logsink: + value: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: "logs-sink" + sink_type: "opensearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "opensearch-logs" + index_days_max: 5 + Create an elasticsearch logsink: + value: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: "logs-sink" + sink_type: "elasticsearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "elasticsearch-logs" + index_days_max: 5 + Create a rsyslog logsink: + value: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: logs-sink + sink_type: rsyslog + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc5424 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml new file mode 100644 index 000000000..c41bef0b9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml @@ -0,0 +1,42 @@ +description: A JSON object with a key of `sinks`. + +headers: + ratelimit-limit: + $ref: "../../../shared/headers.yml#/ratelimit-limit" + ratelimit-remaining: + $ref: "../../../shared/headers.yml#/ratelimit-remaining" + ratelimit-reset: + $ref: "../../../shared/headers.yml#/ratelimit-reset" + +content: + application/json: + schema: + properties: + sinks: + type: array + items: + allOf: + - $ref: "../models/logsink_verbose.yml" + required: + - sink_id + - sink_name + - sink_type + - config + example: + sinks: + - sink_id: 799990b6-d551-454b-9ffe-b8618e9d6272 + sink_name: logs-sink-1 + sink_type: rsyslog + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc5424 + - sink_id: d6e95157-5f58-48d0-9023-8cfb409d102a + sink_name: logs-sink-2 + sink_type: rsyslog + config: + server: 192.168.10.1 + port: 514 + tls: false + format: rfc3164 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml index 1aa36f3ac..992e725dc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml @@ -2,16 +2,16 @@ description: A JSON string with a key of `options`. headers: ratelimit-limit: - $ref: '../../../shared/headers.yml#/ratelimit-limit' + $ref: "../../../shared/headers.yml#/ratelimit-limit" ratelimit-remaining: - $ref: '../../../shared/headers.yml#/ratelimit-remaining' + $ref: "../../../shared/headers.yml#/ratelimit-remaining" ratelimit-reset: - $ref: '../../../shared/headers.yml#/ratelimit-reset' + $ref: "../../../shared/headers.yml#/ratelimit-reset" content: application/json: schema: - $ref: '../models/options.yml' + $ref: "../models/options.yml" example: options: kafka: @@ -28,19 +28,27 @@ content: - syd1 - tor1 versions: - - '3.4' - - '3.5' + - "3.6" + - "3.7" layouts: - num_nodes: 3 sizes: - - db-s-1vcpu-2gb + - gd-2vcpu-8gb + - gd-4vcpu-16gb - db-s-2vcpu-4gb + - db-s-2vcpu-2gb + - num_nodes: 6 + sizes: + - gd-2vcpu-8gb + - gd-4vcpu-16gb + - num_nodes: 9 + sizes: + - gd-2vcpu-8gb + - gd-4vcpu-16gb + - num_nodes: 15 + sizes: - gd-2vcpu-8gb - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb mongodb: regions: - ams3 @@ -55,9 +63,9 @@ content: - syd1 - tor1 versions: - - '4.4' - - '5.0' - - '6.0' + - "5.0" + - "6.0" + - "7.0" layouts: - num_nodes: 1 sizes: @@ -115,17 +123,10 @@ content: - syd1 - tor1 versions: - - '8' + - "8" layouts: - num_nodes: 1 sizes: - - db-s-1vcpu-1gb - - db-s-1vcpu-2gb - - db-s-2vcpu-4gb - - db-s-4vcpu-8gb - - db-s-6vcpu-16gb - - db-s-8vcpu-32gb - - db-s-16vcpu-64gb - db-s-1vcpu-1gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb @@ -143,20 +144,24 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb - - gd-2vcpu-8gb - - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb + - db-intel-1vcpu-1gb + - db-amd-1vcpu-1gb + - db-intel-1vcpu-2gb + - db-amd-1vcpu-2gb + - db-amd-2vcpu-4gb + - db-intel-2vcpu-4gb + - db-amd-2vcpu-8gb + - db-intel-2vcpu-8gb + - db-intel-4vcpu-8gb + - db-amd-4vcpu-8gb + - db-amd-4vcpu-16gb + - db-intel-4vcpu-16gb + - db-intel-8vcpu-32gb + - db-amd-8vcpu-32gb + - db-intel-16vcpu-64gb + - db-amd-16vcpu-64gb - num_nodes: 2 sizes: - - db-s-1vcpu-2gb - - db-s-2vcpu-4gb - - db-s-4vcpu-8gb - - db-s-6vcpu-16gb - - db-s-8vcpu-32gb - - db-s-16vcpu-64gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb - db-s-4vcpu-8gb @@ -173,20 +178,22 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb - - gd-2vcpu-8gb - - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb + - db-intel-1vcpu-2gb + - db-amd-1vcpu-2gb + - db-amd-2vcpu-4gb + - db-intel-2vcpu-4gb + - db-intel-2vcpu-8gb + - db-amd-2vcpu-8gb + - db-intel-4vcpu-8gb + - db-amd-4vcpu-8gb + - db-intel-4vcpu-16gb + - db-amd-4vcpu-16gb + - db-amd-8vcpu-32gb + - db-intel-8vcpu-32gb + - db-amd-16vcpu-64gb + - db-intel-16vcpu-64gb - num_nodes: 3 sizes: - - db-s-1vcpu-2gb - - db-s-2vcpu-4gb - - db-s-4vcpu-8gb - - db-s-6vcpu-16gb - - db-s-8vcpu-32gb - - db-s-16vcpu-64gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb - db-s-4vcpu-8gb @@ -203,13 +210,21 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb - - gd-2vcpu-8gb - - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb - pg: + - db-intel-1vcpu-2gb + - db-amd-1vcpu-2gb + - db-amd-2vcpu-4gb + - db-intel-2vcpu-4gb + - db-intel-2vcpu-8gb + - db-amd-2vcpu-8gb + - db-intel-4vcpu-8gb + - db-amd-4vcpu-8gb + - db-intel-4vcpu-16gb + - db-amd-4vcpu-16gb + - db-amd-8vcpu-32gb + - db-intel-8vcpu-32gb + - db-amd-16vcpu-64gb + - db-intel-16vcpu-64gb + opensearch: regions: - ams3 - blr1 @@ -223,20 +238,70 @@ content: - syd1 - tor1 versions: - - '12' - - '13' - - '14' - - '15' + - "1" + - "2" layouts: - num_nodes: 1 sizes: - - db-s-1vcpu-1gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb + - gd-2vcpu-8gb + - m3-2vcpu-16gb - db-s-4vcpu-8gb - - db-s-6vcpu-16gb - - db-s-8vcpu-32gb - - db-s-16vcpu-64gb + - gd-4vcpu-16gb + - m3-4vcpu-32gb + - m3-8vcpu-64gb + - num_nodes: 3 + sizes: + - db-s-2vcpu-4gb + - gd-2vcpu-8gb + - m3-2vcpu-16gb + - db-s-4vcpu-8gb + - gd-4vcpu-16gb + - m3-4vcpu-32gb + - m3-8vcpu-64gb + - num_nodes: 6 + sizes: + - gd-2vcpu-8gb + - m3-2vcpu-16gb + - gd-4vcpu-16gb + - m3-4vcpu-32gb + - m3-8vcpu-64gb + - num_nodes: 9 + sizes: + - gd-2vcpu-8gb + - m3-2vcpu-16gb + - gd-4vcpu-16gb + - m3-4vcpu-32gb + - m3-8vcpu-64gb + - num_nodes: 15 + sizes: + - gd-2vcpu-8gb + - m3-2vcpu-16gb + - gd-4vcpu-16gb + - m3-4vcpu-32gb + - m3-8vcpu-64gb + pg: + regions: + - ams3 + - blr1 + - fra1 + - lon1 + - nyc1 + - nyc3 + - sfo2 + - sfo3 + - sgp1 + - syd1 + - tor1 + versions: + - "13" + - "14" + - "15" + - "16" + layouts: + - num_nodes: 1 + sizes: - db-s-1vcpu-1gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb @@ -254,20 +319,24 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb - - gd-2vcpu-8gb - - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb + - db-intel-1vcpu-1gb + - db-amd-1vcpu-1gb + - db-intel-1vcpu-2gb + - db-amd-1vcpu-2gb + - db-amd-2vcpu-4gb + - db-intel-2vcpu-4gb + - db-amd-2vcpu-8gb + - db-intel-2vcpu-8gb + - db-intel-4vcpu-8gb + - db-amd-4vcpu-8gb + - db-amd-4vcpu-16gb + - db-intel-4vcpu-16gb + - db-intel-8vcpu-32gb + - db-amd-8vcpu-32gb + - db-intel-16vcpu-64gb + - db-amd-16vcpu-64gb - num_nodes: 2 sizes: - - db-s-1vcpu-2gb - - db-s-2vcpu-4gb - - db-s-4vcpu-8gb - - db-s-6vcpu-16gb - - db-s-8vcpu-32gb - - db-s-16vcpu-64gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb - db-s-4vcpu-8gb @@ -284,20 +353,22 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb - - gd-2vcpu-8gb - - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb + - db-intel-1vcpu-2gb + - db-amd-1vcpu-2gb + - db-amd-2vcpu-4gb + - db-intel-2vcpu-4gb + - db-intel-2vcpu-8gb + - db-amd-2vcpu-8gb + - db-intel-4vcpu-8gb + - db-amd-4vcpu-8gb + - db-intel-4vcpu-16gb + - db-amd-4vcpu-16gb + - db-amd-8vcpu-32gb + - db-intel-8vcpu-32gb + - db-amd-16vcpu-64gb + - db-intel-16vcpu-64gb - num_nodes: 3 sizes: - - db-s-1vcpu-2gb - - db-s-2vcpu-4gb - - db-s-4vcpu-8gb - - db-s-6vcpu-16gb - - db-s-8vcpu-32gb - - db-s-16vcpu-64gb - db-s-1vcpu-2gb - db-s-2vcpu-4gb - db-s-4vcpu-8gb @@ -314,12 +385,20 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb - - gd-2vcpu-8gb - - gd-4vcpu-16gb - - gd-8vcpu-32gb - - gd-16vcpu-64gb - - gd-32vcpu-128gb - - gd-40vcpu-160gb + - db-intel-1vcpu-2gb + - db-amd-1vcpu-2gb + - db-amd-2vcpu-4gb + - db-intel-2vcpu-4gb + - db-intel-2vcpu-8gb + - db-amd-2vcpu-8gb + - db-intel-4vcpu-8gb + - db-amd-4vcpu-8gb + - db-intel-4vcpu-16gb + - db-amd-4vcpu-16gb + - db-amd-8vcpu-32gb + - db-intel-8vcpu-32gb + - db-amd-16vcpu-64gb + - db-intel-16vcpu-64gb redis: regions: - ams3 @@ -334,7 +413,7 @@ content: - syd1 - tor1 versions: - - '7' + - "7" layouts: - num_nodes: 1 sizes: @@ -365,88 +444,63 @@ content: - m-16vcpu-128gb - m-24vcpu-192gb - m-32vcpu-256gb - opensearch: - regions: - - ams3 - - blr1 - - fra1 - - lon1 - - nyc1 - - nyc3 - - sfo2 - - sfo3 - - sgp1 - - syd1 - - tor1 - versions: - - '1' - - '2' - layouts: - - num_nodes: 1 - sizes: - - db-s-2vcpu-4gb - - db-s-4vcpu-8gb - num_nodes: 3 sizes: + - db-s-1vcpu-2gb - db-s-2vcpu-4gb - db-s-4vcpu-8gb - - m3-2vcpu-16gb - - m3-4vcpu-32gb - - num_nodes: 6 - sizes: - - m3-2vcpu-16gb - - m3-4vcpu-32gb - - num_nodes: 9 - sizes: - - m3-2vcpu-16gb - - m3-4vcpu-32gb - - num_nodes: 15 - sizes: - - m3-2vcpu-16gb - - m3-4vcpu-32gb + - db-s-6vcpu-16gb + - db-s-8vcpu-32gb + - db-s-16vcpu-64gb + - m-2vcpu-16gb + - m-4vcpu-32gb + - m-8vcpu-64gb + - m-16vcpu-128gb + - m-24vcpu-192gb + - m-32vcpu-256gb version_availability: kafka: - - end_of_life: '2024-05-13T00:00:00Z' - end_of_availability: '2024-02-13T00:00:00Z' - version: '3.4' - - end_of_life: '2024-07-31T00:00:00Z' - end_of_availability: '2024-04-30T00:00:00Z' - version: '3.5' + - end_of_life: + end_of_availability: "2024-07-18T00:00:00Z" + version: "3.6" + - end_of_life: + end_of_availability: "2025-01-17T00:00:00Z" + version: "3.7" mongodb: - - end_of_life: '2024-02-01T08:00:00Z' - end_of_availability: null - version: '4.4' - - end_of_life: '2024-10-01T07:00:00Z' - end_of_availability: null - version: '5.0' - - end_of_life: '2025-07-01T07:00:00Z' - end_of_availability: null - version: '6.0' + - end_of_life: "2024-10-01T07:00:00Z" + end_of_availability: + version: "5.0" + - end_of_life: "2025-07-01T07:00:00Z" + end_of_availability: + version: "6.0" + - end_of_life: "2026-08-01T07:00:00Z" + end_of_availability: + version: "7.0" mysql: - - end_of_life: null - end_of_availability: null - version: '8' + - end_of_life: + end_of_availability: + version: "8" opensearch: - - end_of_life: null - end_of_availability: null - version: '1' - - end_of_life: null - end_of_availability: null - version: '2' + - end_of_life: + end_of_availability: + version: "1" + - end_of_life: + end_of_availability: + version: "2" pg: - - end_of_life: '2024-11-14T00:00:00Z' - end_of_availability: '2024-05-14T00:00:00Z' - version: '12' - - end_of_life: '2025-11-13T00:00:00Z' - end_of_availability: '2025-05-13T00:00:00Z' - version: '13' - - end_of_life: '2026-11-12T00:00:00Z' - end_of_availability: '2026-05-12T00:00:00Z' - version: '14' - - end_of_life: '2027-11-11T00:00:00Z' - end_of_availability: '2027-05-12T00:00:00Z' - version: '15' + - end_of_life: "2025-11-13T00:00:00Z" + end_of_availability: "2025-05-13T00:00:00Z" + version: "13" + - end_of_life: "2026-11-12T00:00:00Z" + end_of_availability: "2026-05-12T00:00:00Z" + version: "14" + - end_of_life: "2027-11-11T00:00:00Z" + end_of_availability: "2027-05-12T00:00:00Z" + version: "15" + - end_of_life: "2028-11-09T00:00:00Z" + end_of_availability: "2028-05-09T00:00:00Z" + version: "16" redis: - - end_of_life: null - end_of_availability: null - version: '7' + - end_of_life: + end_of_availability: + version: "7" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml index b4fd0d25b..44b4b4ad8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster.yml @@ -156,6 +156,8 @@ properties: description: A read-only boolean value indicating if a container registry is integrated with the cluster. + control_plane_firewall: + $ref: 'control_plane_firewall.yml' required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml index 0ad741e76..5fcc7b02a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml @@ -45,5 +45,8 @@ properties: is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. + control_plane_firewall: + $ref: 'control_plane_firewall.yml' + required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml new file mode 100644 index 000000000..393c70454 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml @@ -0,0 +1,18 @@ +type: object +nullable: true +description: An object specifying the control plane firewall for the Kubernetes cluster. + Control plane firewall is in early availability (invite only). +properties: + enable: + type: boolean + description: Indicates whether the control plane firewall is enabled. + example: true + + allowed_addresses: + type: array + description: An array of public addresses (IPv4 or CIDR) allowed to access the control plane. + items: + type: string + example: + - "1.2.3.4/32" + - "1.1.0.0/16" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml index 87fbd9cc4..05079644e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml @@ -98,6 +98,11 @@ kubernetes_clusters_all: surge_upgrade: false registry_enabled: false ha: false + control_plane_firewall: + enabled: true + allowed_addresses: + - "1.2.3.4/32" + - "1.1.0.0/16" meta: total: 1 @@ -200,6 +205,11 @@ kubernetes_single: surge_upgrade: false registry_enabled: false ha: false + control_plane_firewall: + enabled: true + allowed_addresses: + - "1.2.3.4/32" + - "1.1.0.0/16" kubernetes_updated: value: @@ -300,6 +310,11 @@ kubernetes_updated: surge_upgrade: true registry_enabled: false ha: false + control_plane_firewall: + enabled: true + allowed_addresses: + - "1.2.3.4/32" + - "1.1.0.0/16" kubernetes_clusters_create_basic_response: value: @@ -365,6 +380,11 @@ kubernetes_clusters_create_basic_response: surge_upgrade: false registry_enabled: false ha: false + control_plane_firewall: + enabled: true + allowed_addresses: + - "1.2.3.4/32" + - "1.1.0.0/16" kubernetes_clusters_multi_pool_response: value: @@ -467,6 +487,11 @@ kubernetes_clusters_multi_pool_response: surge_upgrade: false registry_enabled: false ha: false + control_plane_firewall: + enabled: true + allowed_addresses: + - "1.2.3.4/32" + - "1.1.0.0/16" kubernetes_options: value: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml index bbcd750e0..a5e3d778d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml @@ -56,4 +56,4 @@ x-codeSamples: security: - bearer_auth: - 'registry:read' - - 'registry:create' + - 'registry:update' diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts index 134c16d96..5e4c1668d 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -410,7 +410,8 @@ export type paths = { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ readonly get: operations["apps/get-by-slug"]; readonly put?: never; @@ -610,10 +611,15 @@ export type paths = { }; /** * List all Copilot seat assignments for an enterprise - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -636,7 +642,8 @@ export type paths = { }; /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -720,7 +727,8 @@ export type paths = { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-public-events"]; readonly put?: never; @@ -752,7 +760,8 @@ export type paths = { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ readonly get: operations["activity/get-feeds"]; readonly put?: never; @@ -780,7 +789,8 @@ export type paths = { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ readonly post: operations["gists/create"]; readonly delete?: never; @@ -1120,10 +1130,8 @@ export type paths = { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1365,7 +1373,8 @@ export type paths = { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ readonly get: operations["meta/get"]; readonly put?: never; @@ -1383,7 +1392,11 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-public-events-for-repo-network"]; readonly put?: never; readonly post?: never; @@ -1510,7 +1523,8 @@ export type paths = { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ readonly get: operations["orgs/list"]; readonly put?: never; @@ -1536,17 +1550,6 @@ export type paths = { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -1569,20 +1572,13 @@ export type paths = { readonly head?: never; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -2356,6 +2352,30 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/attestations/{subject_digest}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly get: operations["orgs/list-attestations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/blocks": { readonly parameters: { readonly query?: never; @@ -2428,6 +2448,205 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/code-security/configurations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configurations-for-org"]; + readonly put?: never; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly post: operations["code-security/create-configuration"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/defaults": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-default-configurations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/detach": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly delete: operations["code-security/detach-configuration"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configuration"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly delete: operations["code-security/delete-configuration"]; + readonly options?: never; + readonly head?: never; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly patch: operations["code-security/update-configuration"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly post: operations["code-security/attach-configuration"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly put: operations["code-security/set-configuration-as-default"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-repositories-for-configuration"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/codespaces": { readonly parameters: { readonly query?: never; @@ -2656,7 +2875,8 @@ export type paths = { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -2684,7 +2904,8 @@ export type paths = { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. * Only organization owners can view assigned seats. @@ -2711,7 +2932,8 @@ export type paths = { readonly put?: never; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2722,12 +2944,15 @@ export type paths = { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2757,7 +2982,8 @@ export type paths = { readonly put?: never; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2768,12 +2994,15 @@ export type paths = { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2801,7 +3030,8 @@ export type paths = { }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3021,7 +3251,11 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-public-org-events"]; readonly put?: never; readonly post?: never; @@ -3422,10 +3656,8 @@ export type paths = { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -3562,7 +3794,8 @@ export type paths = { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * @@ -3734,35 +3967,6 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/orgs/{org}/organization-fine-grained-permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly get: operations["orgs/list-organization-fine-grained-permissions"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; readonly "/orgs/{org}/organization-roles": { readonly parameters: { readonly query?: never; @@ -3772,7 +3976,7 @@ export type paths = { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3783,18 +3987,7 @@ export type paths = { */ readonly get: operations["orgs/list-org-roles"]; readonly put?: never; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly post: operations["orgs/create-custom-organization-role"]; + readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; @@ -3813,7 +4006,7 @@ export type paths = { readonly post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3835,7 +4028,7 @@ export type paths = { readonly get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3845,7 +4038,7 @@ export type paths = { readonly post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3869,7 +4062,7 @@ export type paths = { readonly post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3891,7 +4084,7 @@ export type paths = { readonly get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3901,7 +4094,7 @@ export type paths = { readonly post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3922,7 +4115,7 @@ export type paths = { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3934,33 +4127,10 @@ export type paths = { readonly get: operations["orgs/get-org-role"]; readonly put?: never; readonly post?: never; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly delete: operations["orgs/delete-custom-organization-role"]; + readonly delete?: never; readonly options?: never; readonly head?: never; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly patch: operations["orgs/patch-custom-organization-role"]; + readonly patch?: never; readonly trace?: never; }; readonly "/orgs/{org}/organization-roles/{role_id}/teams": { @@ -3972,7 +4142,7 @@ export type paths = { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3996,7 +4166,7 @@ export type paths = { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -4544,7 +4714,8 @@ export type paths = { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ readonly get: operations["repos/list-for-org"]; readonly put?: never; @@ -4868,7 +5039,8 @@ export type paths = { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ readonly get: operations["teams/get-by-name"]; readonly put?: never; @@ -4879,7 +5051,8 @@ export type paths = { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ readonly delete: operations["teams/delete-in-org"]; readonly options?: never; @@ -4888,7 +5061,8 @@ export type paths = { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ readonly patch: operations["teams/update-in-org"]; readonly trace?: never; @@ -4904,7 +5078,8 @@ export type paths = { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4916,7 +5091,8 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4938,7 +5114,8 @@ export type paths = { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4949,7 +5126,8 @@ export type paths = { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4960,7 +5138,8 @@ export type paths = { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4978,7 +5157,8 @@ export type paths = { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4990,7 +5170,8 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5012,7 +5193,8 @@ export type paths = { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5023,7 +5205,8 @@ export type paths = { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5034,7 +5217,8 @@ export type paths = { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5052,7 +5236,8 @@ export type paths = { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5064,7 +5249,8 @@ export type paths = { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5087,7 +5273,8 @@ export type paths = { readonly post?: never; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -5110,7 +5297,8 @@ export type paths = { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5122,7 +5310,8 @@ export type paths = { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5145,7 +5334,8 @@ export type paths = { readonly post?: never; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -5168,7 +5358,8 @@ export type paths = { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ readonly get: operations["teams/list-pending-invitations-in-org"]; readonly put?: never; @@ -5214,10 +5405,11 @@ export type paths = { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -5228,13 +5420,15 @@ export type paths = { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ readonly put: operations["teams/add-or-update-membership-for-user-in-org"]; readonly post?: never; @@ -5244,9 +5438,11 @@ export type paths = { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ readonly delete: operations["teams/remove-membership-for-user-in-org"]; readonly options?: never; @@ -5265,7 +5461,8 @@ export type paths = { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ readonly get: operations["teams/list-projects-in-org"]; readonly put?: never; @@ -5287,14 +5484,16 @@ export type paths = { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ readonly get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ readonly put: operations["teams/add-or-update-project-permissions-in-org"]; readonly post?: never; @@ -5302,7 +5501,8 @@ export type paths = { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ readonly delete: operations["teams/remove-project-in-org"]; readonly options?: never; @@ -5321,7 +5521,8 @@ export type paths = { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ readonly get: operations["teams/list-repos-in-org"]; readonly put?: never; @@ -5349,14 +5550,16 @@ export type paths = { * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -5366,7 +5569,8 @@ export type paths = { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly delete: operations["teams/remove-repo-in-org"]; readonly options?: never; @@ -5385,7 +5589,8 @@ export type paths = { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ readonly get: operations["teams/list-child-in-org"]; readonly put?: never; @@ -5407,7 +5612,11 @@ export type paths = { readonly put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * @@ -5650,7 +5859,8 @@ export type paths = { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -5663,7 +5873,8 @@ export type paths = { * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ readonly get: operations["rate-limit/get"]; readonly put?: never; @@ -5685,7 +5896,8 @@ export type paths = { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ readonly get: operations["repos/get"]; readonly put?: never; @@ -6605,8 +6817,8 @@ export type paths = { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -7193,6 +7405,54 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/attestations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly post: operations["repos/create-attestation"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/attestations/{subject_digest}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly get: operations["repos/list-attestations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/autolinks": { readonly parameters: { readonly query?: never; @@ -7327,9 +7587,11 @@ export type paths = { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ readonly put: operations["repos/update-branch-protection"]; readonly post?: never; @@ -7402,7 +7664,8 @@ export type paths = { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ readonly patch: operations["repos/update-pull-request-review-protection"]; readonly trace?: never; @@ -7420,7 +7683,8 @@ export type paths = { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ readonly get: operations["repos/get-commit-signature-protection"]; readonly put?: never; @@ -7518,7 +7782,8 @@ export type paths = { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ readonly get: operations["repos/get-access-restrictions"]; readonly put?: never; @@ -7680,7 +7945,8 @@ export type paths = { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -7710,7 +7976,8 @@ export type paths = { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ readonly post: operations["checks/create"]; readonly delete?: never; @@ -7730,7 +7997,8 @@ export type paths = { * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7744,7 +8012,8 @@ export type paths = { * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7810,7 +8079,8 @@ export type paths = { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7853,7 +8123,8 @@ export type paths = { * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7877,7 +8148,8 @@ export type paths = { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -8007,8 +8279,8 @@ export type paths = { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8660,7 +8932,8 @@ export type paths = { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -8800,7 +9073,8 @@ export type paths = { readonly post?: never; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -8952,7 +9226,8 @@ export type paths = { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -9009,7 +9284,8 @@ export type paths = { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -9035,7 +9311,8 @@ export type paths = { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -9236,7 +9513,8 @@ export type paths = { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -9252,7 +9530,8 @@ export type paths = { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ readonly delete: operations["repos/delete-file"]; readonly options?: never; @@ -9680,7 +9959,8 @@ export type paths = { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -9691,9 +9971,11 @@ export type paths = { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -9818,7 +10100,9 @@ export type paths = { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -10039,8 +10323,8 @@ export type paths = { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - * + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-repo-events"]; readonly put?: never; @@ -10065,9 +10349,11 @@ export type paths = { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ readonly post: operations["repos/create-fork"]; readonly delete?: never; @@ -10233,7 +10519,8 @@ export type paths = { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -10257,7 +10544,8 @@ export type paths = { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ readonly get: operations["git/get-ref"]; readonly put?: never; @@ -10445,8 +10733,8 @@ export type paths = { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ readonly get: operations["git/get-tree"]; readonly put?: never; @@ -10628,7 +10916,8 @@ export type paths = { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ readonly post: operations["repos/test-push-webhook"]; readonly delete?: never; @@ -10649,7 +10938,8 @@ export type paths = { * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -10692,8 +10982,8 @@ export type paths = { * Importing into a GitHub repository with GitHub Actions enabled is not supported and will * return a status `422 Unprocessable Entity` response. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly put: operations["migrations/start-import"]; readonly post?: never; @@ -10702,8 +10992,8 @@ export type paths = { * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly delete: operations["migrations/cancel-import"]; readonly options?: never; @@ -10718,7 +11008,8 @@ export type paths = { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/update-import"]; readonly trace?: never; @@ -10737,7 +11028,8 @@ export type paths = { * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-commit-authors"]; readonly put?: never; @@ -10767,8 +11059,8 @@ export type paths = { * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/map-commit-author"]; readonly trace?: never; @@ -10785,8 +11077,8 @@ export type paths = { * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-large-files"]; readonly put?: never; @@ -10819,8 +11111,8 @@ export type paths = { * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/set-lfs-preference"]; readonly trace?: never; @@ -10924,10 +11216,8 @@ export type paths = { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11066,7 +11356,8 @@ export type paths = { readonly post?: never; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -11132,10 +11423,8 @@ export type paths = { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11391,7 +11680,8 @@ export type paths = { readonly post?: never; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ @@ -12134,7 +12424,8 @@ export type paths = { readonly post?: never; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -12337,8 +12628,8 @@ export type paths = { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12438,7 +12729,8 @@ export type paths = { * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -12544,9 +12836,8 @@ export type paths = { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12786,9 +13077,8 @@ export type paths = { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ readonly get: operations["repos/get-release"]; readonly put?: never; @@ -12882,7 +13172,8 @@ export type paths = { readonly post?: never; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -13217,7 +13508,8 @@ export type paths = { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ readonly post: operations["security-advisories/create-fork"]; readonly delete?: never; @@ -13259,12 +13551,10 @@ export type paths = { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ readonly get: operations["repos/get-code-frequency-stats"]; readonly put?: never; @@ -13312,7 +13602,8 @@ export type paths = { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ readonly get: operations["repos/get-contributors-stats"]; readonly put?: never; @@ -13470,8 +13761,8 @@ export type paths = { /** * Deprecated - List tag protection states for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13482,8 +13773,8 @@ export type paths = { /** * Deprecated - Create a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13508,8 +13799,8 @@ export type paths = { /** * Deprecated - Delete a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13532,7 +13823,9 @@ export type paths = { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ readonly get: operations["repos/download-tarball-archive"]; readonly put?: never; @@ -13728,7 +14021,8 @@ export type paths = { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ readonly get: operations["repos/download-zipball-archive"]; readonly put?: never; @@ -13871,7 +14165,8 @@ export type paths = { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ readonly get: operations["search/issues-and-pull-requests"]; readonly put?: never; @@ -14006,7 +14301,8 @@ export type paths = { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ readonly get: operations["teams/get-legacy"]; readonly put?: never; @@ -14014,7 +14310,8 @@ export type paths = { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14026,11 +14323,13 @@ export type paths = { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ readonly patch: operations["teams/update-legacy"]; readonly trace?: never; @@ -14045,7 +14344,8 @@ export type paths = { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14056,7 +14356,8 @@ export type paths = { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14081,7 +14382,8 @@ export type paths = { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14093,7 +14395,8 @@ export type paths = { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14105,7 +14408,8 @@ export type paths = { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14124,7 +14428,8 @@ export type paths = { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14135,7 +14440,8 @@ export type paths = { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14160,7 +14466,8 @@ export type paths = { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14172,7 +14479,8 @@ export type paths = { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14184,7 +14492,8 @@ export type paths = { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14203,7 +14512,8 @@ export type paths = { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14214,7 +14524,8 @@ export type paths = { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14239,7 +14550,8 @@ export type paths = { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14250,7 +14562,8 @@ export type paths = { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14275,7 +14588,8 @@ export type paths = { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14298,7 +14612,8 @@ export type paths = { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14339,7 +14654,8 @@ export type paths = { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -14356,7 +14672,8 @@ export type paths = { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ readonly delete: operations["teams/remove-member-legacy"]; readonly options?: never; @@ -14374,7 +14691,8 @@ export type paths = { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14389,13 +14707,15 @@ export type paths = { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -14406,13 +14726,15 @@ export type paths = { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ readonly delete: operations["teams/remove-membership-for-user-legacy"]; readonly options?: never; @@ -14430,7 +14752,8 @@ export type paths = { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14453,7 +14776,8 @@ export type paths = { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14461,7 +14785,8 @@ export type paths = { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14470,7 +14795,8 @@ export type paths = { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14490,7 +14816,8 @@ export type paths = { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ readonly get: operations["teams/list-repos-legacy"]; readonly put?: never; @@ -14511,9 +14838,11 @@ export type paths = { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ @@ -14521,7 +14850,8 @@ export type paths = { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14532,7 +14862,8 @@ export type paths = { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -14552,7 +14883,8 @@ export type paths = { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ readonly get: operations["teams/list-child-legacy"]; readonly put?: never; @@ -15304,10 +15636,8 @@ export type paths = { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -16071,6 +16401,30 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/user/{account_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + readonly get: operations["users/get-by-id"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/users": { readonly parameters: { readonly query?: never; @@ -16117,6 +16471,30 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/users/{username}/attestations/{subject_digest}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly get: operations["users/list-attestations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/users/{username}/docker/conflicts": { readonly parameters: { readonly query?: never; @@ -16149,6 +16527,9 @@ export type paths = { /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-events-for-authenticated-user"]; readonly put?: never; @@ -16169,6 +16550,9 @@ export type paths = { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-org-events-for-authenticated-user"]; readonly put?: never; @@ -16186,7 +16570,11 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-public-events-for-user"]; readonly put?: never; readonly post?: never; @@ -16570,7 +16958,11 @@ export type paths = { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-received-events-for-user"]; readonly put?: never; @@ -16588,7 +16980,11 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-received-public-events-for-user"]; readonly put?: never; readonly post?: never; @@ -16918,7 +17314,10 @@ export type components = { readonly email?: string | null; /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; @@ -17104,7 +17503,10 @@ export type components = { readonly email?: string | null; /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; @@ -17222,7 +17624,8 @@ export type components = { readonly metadata?: string; readonly contents?: string; readonly deployments?: string; - readonly [key: string]: string | undefined; + } & { + readonly [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -17866,6 +18269,7 @@ export type components = { */ readonly repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -18266,6 +18670,7 @@ export type components = { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ readonly authorization: { + /** Format: int64 */ readonly id: number; /** Format: uri */ readonly url: string; @@ -18954,6 +19359,7 @@ export type components = { * @description Group of enterprise owners and/or members */ readonly "enterprise-team": { + /** Format: int64 */ readonly id: number; readonly name: string; readonly slug: string; @@ -19037,7 +19443,7 @@ export type components = { /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ readonly total_active_chat_users?: number; /** @description Breakdown of Copilot code completions usage by language and editor */ - readonly breakdown: readonly { + readonly breakdown: readonly ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ readonly language?: string; /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ @@ -19052,8 +19458,9 @@ export type components = { readonly lines_accepted?: number; /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ readonly active_users?: number; + } & { readonly [key: string]: unknown; - }[] | null; + })[] | null; }; /** @description The security alert number. */ readonly "alert-number": number; @@ -19186,6 +19593,7 @@ export type components = { */ readonly "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -19658,7 +20066,8 @@ export type components = { readonly metadata?: string; readonly contents?: string; readonly deployments?: string; - readonly [key: string]: string | undefined; + } & { + readonly [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -19962,7 +20371,7 @@ export type components = { readonly language?: string; readonly raw_url?: string; readonly size?: number; - } | undefined; + }; }; readonly public: boolean; /** Format: date-time */ @@ -19985,6 +20394,7 @@ export type components = { */ readonly "public-user": { readonly login: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; /** Format: uri */ @@ -20109,7 +20519,7 @@ export type components = { readonly language?: string; readonly raw_url?: string; readonly size?: number; - } | undefined; + }; }; readonly public: boolean; /** Format: date-time */ @@ -20135,7 +20545,7 @@ export type components = { readonly git_push_url?: string; readonly html_url?: string; readonly files?: { - readonly [key: string]: ({ + readonly [key: string]: { readonly filename?: string; readonly type?: string; readonly language?: string; @@ -20143,7 +20553,7 @@ export type components = { readonly size?: number; readonly truncated?: boolean; readonly content?: string; - } | null) | undefined; + } | null; }; readonly public?: boolean; readonly created_at?: string; @@ -20492,13 +20902,20 @@ export type components = { /** @enum {string} */ readonly status?: "enabled" | "disabled"; }; + readonly secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + readonly status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ readonly "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; @@ -20878,47 +21295,60 @@ export type components = { /** @example false */ readonly web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -21010,7 +21440,8 @@ export type components = { readonly verified_allowed?: boolean; /** @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. */ + * > [!NOTE] + * > The `patterns_allowed` setting only applies to public repositories. */ readonly patterns_allowed?: readonly string[]; }; /** @@ -21235,7 +21666,7 @@ export type components = { * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; + readonly "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ readonly "code-scanning-alert-dismissed-comment": string | null; readonly "code-scanning-alert-rule-summary": { @@ -21243,8 +21674,6 @@ export type components = { readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; - /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -21257,6 +21686,8 @@ export type components = { readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; + /** @description A set of tags applicable for the rule. */ + readonly tags?: readonly string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-version": string | null; @@ -21321,6 +21752,102 @@ export type components = { readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; readonly repository: components["schemas"]["simple-repository"]; }; + /** @description A code security configuration */ + readonly "code-security-configuration": { + /** @description The ID of the code security configuration */ + readonly id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name?: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + readonly target_type?: "global" | "organization"; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + readonly url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + readonly html_url?: string; + /** Format: date-time */ + readonly created_at?: string; + /** Format: date-time */ + readonly updated_at?: string; + }; + /** @description A list of default code security configurations */ + readonly "code-security-default-configurations": readonly { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + readonly "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + readonly repository?: components["schemas"]["simple-repository"]; + }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -21368,7 +21895,10 @@ export type components = { * @description A codespace. */ readonly codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** * @description Automatically generated name of this codespace. @@ -21622,6 +22152,7 @@ export type components = { * @enum {string} */ readonly seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + } & { readonly [key: string]: unknown; }; /** @@ -21670,7 +22201,10 @@ export type components = { * @description Minimal Repository */ readonly "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; @@ -21922,6 +22456,7 @@ export type components = { * @description Organization Invitation */ readonly "organization-invitation": { + /** Format: int64 */ readonly id: number; readonly login: string | null; readonly email: string | null; @@ -22063,7 +22598,10 @@ export type components = { * @description A migration. */ readonly migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ readonly id: number; readonly owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -22101,20 +22639,15 @@ export type components = { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ readonly exclude?: readonly string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - readonly "organization-fine-grained-permission": { - readonly name: string; - readonly description: string; - }; /** * Organization Role * @description Organization roles */ readonly "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ readonly id: number; /** @description The name of the role. */ readonly name: string; @@ -22374,13 +22907,13 @@ export type components = { /** @description Permissions requested, categorized by type of permission. */ readonly permissions: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ @@ -22410,13 +22943,13 @@ export type components = { /** @description Permissions requested, categorized by type of permission. */ readonly permissions: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -22552,6 +23085,7 @@ export type components = { */ readonly "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -22927,7 +23461,10 @@ export type components = { * @description Full Repository */ readonly "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; @@ -23301,6 +23838,11 @@ export type components = { readonly name: string; /** @description The values to match for the repository property */ readonly property_values: readonly string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + readonly source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -23356,6 +23898,36 @@ export type components = { /** @enum {string} */ readonly type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + readonly "repository-rule-merge-queue": { + /** @enum {string} */ + readonly type: "merge_queue"; + readonly parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + readonly check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + readonly grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + readonly max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + readonly max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + readonly merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + readonly min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + readonly min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -23414,6 +23986,8 @@ export type components = { /** @enum {string} */ readonly type: "required_status_checks"; readonly parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + readonly do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ readonly required_status_checks: readonly components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -23565,6 +24139,8 @@ export type components = { /** @enum {string} */ readonly type: "workflows"; readonly parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + readonly do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ readonly workflows: readonly components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -23603,7 +24179,7 @@ export type components = { * Repository Rule * @description A repository rule. */ - readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { /** @enum {string} */ readonly type: "file_path_restriction"; readonly parameters?: { @@ -23644,7 +24220,8 @@ export type components = { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -24688,6 +25265,7 @@ export type components = { */ readonly url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -25106,6 +25684,7 @@ export type components = { }; /** Pull Request Minimal */ readonly "pull-request-minimal": { + /** Format: int64 */ readonly id: number; readonly number: number; readonly url: string; @@ -25113,6 +25692,7 @@ export type components = { readonly ref: string; readonly sha: string; readonly repo: { + /** Format: int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -25122,6 +25702,7 @@ export type components = { readonly ref: string; readonly sha: string; readonly repo: { + /** Format: int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -25391,6 +25972,7 @@ export type components = { readonly "pending-deployment": { readonly environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -25440,6 +26022,7 @@ export type components = { */ readonly url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -25759,6 +26342,7 @@ export type components = { readonly apps_url: string; readonly users: readonly { readonly login?: string; + /** Format: int64 */ readonly id?: number; readonly node_id?: string; readonly avatar_url?: string; @@ -26019,8 +26603,8 @@ export type components = { }; readonly verification?: components["schemas"]["verification"]; }; - readonly author: components["schemas"]["nullable-simple-user"]; - readonly committer: components["schemas"]["nullable-simple-user"]; + readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; readonly parents: readonly { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; @@ -26919,7 +27503,10 @@ export type components = { readonly collaborator: { /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; readonly email?: string | null; readonly name?: string | null; @@ -26994,6 +27581,7 @@ export type components = { */ readonly "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -27030,7 +27618,10 @@ export type components = { readonly "nullable-collaborator": { /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; readonly email?: string | null; readonly name?: string | null; @@ -27178,7 +27769,10 @@ export type components = { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ readonly url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; @@ -27896,6 +28490,11 @@ export type components = { * @example NOASSERTION */ readonly supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + readonly copyrightText?: string; readonly externalRefs?: readonly { /** * @description The category of reference to an external resource this reference refers to. @@ -27921,7 +28520,7 @@ export type components = { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ readonly metadata: { - readonly [key: string]: ((string | number | boolean) | null) | undefined; + readonly [key: string]: (string | number | boolean) | null; }; readonly dependency: { /** @@ -27964,7 +28563,7 @@ export type components = { readonly metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ readonly resolved?: { - readonly [key: string]: components["schemas"]["dependency"] | undefined; + readonly [key: string]: components["schemas"]["dependency"]; }; }; /** @@ -28022,7 +28621,7 @@ export type components = { readonly metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ readonly manifests?: { - readonly [key: string]: components["schemas"]["manifest"] | undefined; + readonly [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time @@ -28041,7 +28640,10 @@ export type components = { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ readonly url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ readonly node_id: string; @@ -28125,6 +28727,7 @@ export type components = { */ readonly environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -29159,6 +29762,7 @@ export type components = { readonly label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ readonly id: number; @@ -29175,14 +29779,20 @@ export type components = { * @example bug */ readonly name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ readonly description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ readonly color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ readonly default: boolean; }; /** @@ -29393,11 +30003,13 @@ export type components = { */ readonly url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ readonly pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -29629,7 +30241,7 @@ export type components = { * @description Language */ readonly language: { - readonly [key: string]: number | undefined; + readonly [key: string]: number; }; /** * License Content @@ -29971,7 +30583,10 @@ export type components = { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ readonly url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; @@ -30241,6 +30856,7 @@ export type components = { readonly gravatar_id: string | null; /** Format: uri */ readonly html_url: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; readonly login: string; @@ -30416,6 +31032,7 @@ export type components = { readonly gravatar_id: string | null; /** Format: uri */ readonly html_url: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; readonly login: string; @@ -30500,6 +31117,7 @@ export type components = { */ readonly "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -30553,9 +31171,15 @@ export type components = { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ readonly url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ readonly pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ readonly id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ readonly node_id: string; @@ -30757,7 +31381,7 @@ export type components = { * Repository Rule * @description A repository rule with ruleset details. */ - readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); readonly "secret-scanning-alert": { readonly number?: components["schemas"]["alert-number"]; readonly created_at?: components["schemas"]["alert-created-at"]; @@ -31632,6 +32256,7 @@ export type components = { */ readonly "user-search-result-item": { readonly login: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; /** Format: uri */ @@ -31685,7 +32310,10 @@ export type components = { readonly "private-user": { /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; @@ -31901,7 +32529,10 @@ export type components = { * @description A codespace. */ readonly "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** * @description Automatically generated name of this codespace. @@ -32067,7 +32698,10 @@ export type components = { * @description A unique encryption key */ readonly "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ readonly id: number; /** @example Octocat's GPG Key */ readonly name?: string | null; @@ -32103,6 +32737,7 @@ export type components = { * } * ] */ readonly subkeys: readonly { + /** Format: int64 */ readonly id?: number; readonly primary_key_id?: number; readonly key_id?: string; @@ -32144,6 +32779,7 @@ export type components = { */ readonly key: { readonly key: string; + /** Format: int64 */ readonly id: number; readonly url: string; readonly title: string; @@ -32223,6 +32859,45 @@ export type components = { readonly starred_at: string; readonly repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + readonly "sigstore-bundle-0": { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly x509CertificateChain?: { + readonly certificates?: readonly { + readonly rawBytes?: string; + }[]; + }; + readonly tlogEntries?: readonly { + readonly logIndex?: string; + readonly logId?: { + readonly keyId?: string; + }; + readonly kindVersion?: { + readonly kind?: string; + readonly version?: string; + }; + readonly integratedTime?: string; + readonly inclusionPromise?: { + readonly signedEntryTimestamp?: string; + }; + readonly inclusionProof?: string | null; + readonly canonicalizedBody?: string; + }[]; + readonly timestampVerificationData?: string | null; + }; + readonly dsseEnvelope?: { + readonly payload?: string; + readonly payloadType?: string; + readonly signatures?: readonly { + readonly sig?: string; + readonly keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -32246,7 +32921,6 @@ export type components = { * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." - * */ readonly "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -32356,6 +33030,7 @@ export type components = { */ readonly "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -32946,6 +33621,13 @@ export type components = { readonly ignore_approvals_from_contributors: boolean; /** @enum {string} */ readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + readonly lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + readonly lock_allows_fork_sync?: boolean; /** @enum {string} */ readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; readonly name: string; @@ -33197,6 +33879,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33267,6 +33950,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33410,6 +34094,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33430,6 +34115,7 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly labels?: readonly components["schemas"]["label"][]; }; readonly webhooks_comment: { /** @@ -33479,6 +34165,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33607,6 +34294,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -34024,6 +34712,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -34505,6 +35194,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -34702,6 +35392,7 @@ export type components = { */ readonly "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -35301,6 +35992,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -35333,37 +36025,37 @@ export type components = { /** @description New requested permissions, categorized by type of permission. */ readonly permissions_added: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ readonly permissions_upgraded: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ readonly permissions_result: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @@ -35633,6 +36325,43 @@ export type components = { readonly duration?: number | null; readonly start_date?: string | null; }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + readonly "projects-v2-status-update": { + readonly id: number; + readonly node_id: string; + readonly project_node_id?: string; + readonly creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly updated_at: string; + /** @enum {string|null} */ + readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @example 2022-04-28 + */ + readonly start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + readonly target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + readonly body?: string | null; + }; /** @description The pull request number. */ readonly webhooks_number: number; readonly "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -35982,7 +36711,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -36164,6 +36896,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -36322,7 +37055,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -36504,6 +37240,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -36840,6 +37577,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -36985,6 +37723,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -37057,6 +37796,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -37780,6 +38520,20 @@ export type components = { /** @enum {string} */ readonly from: "off" | "non_admins" | "everyone"; }; + readonly lock_branch_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + readonly lock_allows_fork_sync?: { + readonly from: boolean | null; + }; + readonly pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + readonly require_last_push_approval?: { + readonly from: boolean | null; + }; readonly required_status_checks?: { readonly from: readonly string[]; }; @@ -39327,6 +40081,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -39380,7 +40135,7 @@ export type components = { readonly definition: components["schemas"]["org-custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property deleted event */ @@ -39393,7 +40148,7 @@ export type components = { }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property updated event */ @@ -39403,7 +40158,7 @@ export type components = { readonly definition: components["schemas"]["org-custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; /** Custom property values updated event */ @@ -42056,7 +42811,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -42551,6 +43309,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -42960,6 +43719,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -43080,6 +43840,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -43490,6 +44251,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -43610,6 +44372,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -44021,6 +44784,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -44141,6 +44905,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -44568,6 +45333,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -44635,6 +45401,7 @@ export type components = { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -45047,6 +45814,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -45467,6 +46235,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -45899,6 +46668,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -46320,6 +47090,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -46742,6 +47513,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -47162,6 +47934,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -47582,6 +48355,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -47721,7 +48495,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -48238,6 +49015,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -48669,6 +49447,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -49088,6 +49867,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -49230,7 +50010,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -49786,6 +50569,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -50447,11 +51231,11 @@ export type components = { }; readonly platform?: string; readonly metadata?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repo?: string; readonly dependencies?: readonly { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }[]; readonly commit_oid?: string; }; @@ -51556,6 +52340,57 @@ export type components = { readonly projects_v2: components["schemas"]["projects-v2"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; + /** Projects v2 Status Update Created Event */ + readonly "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + readonly action: "created"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Deleted Event */ + readonly "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Edited Event */ + readonly "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes?: { + readonly body?: { + readonly from?: string | null; + readonly to?: string | null; + }; + readonly status?: { + /** @enum {string|null} */ + readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** @enum {string|null} */ + readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + }; + readonly start_date?: { + /** Format: date */ + readonly from?: string | null; + /** Format: date */ + readonly to?: string | null; + }; + readonly target_date?: { + /** Format: date */ + readonly from?: string | null; + /** Format: date */ + readonly to?: string | null; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; /** public event */ readonly "webhook-public": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -51871,7 +52706,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -52053,6 +52891,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -52211,7 +53050,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -52393,6 +53235,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -52729,6 +53572,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -53059,7 +53903,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -53241,6 +54088,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -53399,7 +54247,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -53581,6 +54432,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -53917,6 +54769,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -54248,7 +55101,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -54430,6 +55286,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -54770,6 +55627,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -55106,6 +55964,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -55473,7 +56332,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -55655,6 +56517,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -55813,7 +56676,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -55995,6 +56861,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -56331,6 +57198,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -56693,7 +57561,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -56875,6 +57746,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -57033,7 +57905,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -57215,6 +58090,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -57551,6 +58427,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -57882,7 +58759,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -58064,6 +58944,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -58222,7 +59103,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -58404,6 +59288,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -58740,6 +59625,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -59070,7 +59956,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -59252,6 +60141,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -59410,7 +60300,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -59592,6 +60485,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -59928,6 +60822,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -60128,6 +61023,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -60448,7 +61344,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -60630,6 +61529,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -60781,7 +61681,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -60963,6 +61866,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -61248,6 +62152,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -61576,7 +62481,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -61758,6 +62666,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -61909,7 +62818,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -62091,6 +63003,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -62376,6 +63289,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -62705,7 +63619,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -62887,6 +63804,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -63038,7 +63956,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -63220,6 +64141,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -63505,6 +64427,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -63833,7 +64756,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -64015,6 +64941,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -64166,7 +65093,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -64348,6 +65278,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -64633,6 +65564,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -64707,6 +65639,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -65035,7 +65968,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -65176,6 +66112,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -65322,7 +66259,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -65463,6 +66403,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -65748,6 +66689,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -66080,7 +67022,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -66255,6 +67200,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -66413,7 +67359,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -66595,6 +67544,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -66931,6 +67881,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -67297,7 +68248,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -67479,6 +68433,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -67637,7 +68592,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -67819,6 +68777,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -68155,6 +69114,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -68541,7 +69501,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -68723,6 +69686,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -68881,7 +69845,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -69063,6 +70030,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -69399,6 +70367,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -69765,7 +70734,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -69947,6 +70919,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -70105,7 +71078,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -70287,6 +71263,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -70623,6 +71600,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -71006,7 +71984,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -71188,6 +72169,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -71339,7 +72321,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -71521,6 +72506,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -71806,6 +72792,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -72135,7 +73122,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -72278,6 +73268,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -72429,7 +73420,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -72572,6 +73566,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -72857,6 +73852,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -73001,6 +73997,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -73329,7 +74326,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -73472,6 +74472,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -73623,7 +74624,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -73766,6 +74770,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74051,6 +75056,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74195,6 +75201,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74527,7 +75534,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -74709,6 +75719,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74867,7 +75878,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -75042,6 +76056,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -75378,6 +76393,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -75709,7 +76725,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -75891,6 +76910,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -76049,7 +77069,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -76231,6 +77254,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -76567,6 +77591,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -76898,7 +77923,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -77080,6 +78108,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -77238,7 +78267,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -77413,6 +78445,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -77749,6 +78782,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -78079,7 +79113,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -78261,6 +79298,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -78419,7 +79457,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -78601,6 +79642,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -78937,6 +79979,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -79217,7 +80260,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -80180,6 +81226,7 @@ export type components = { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -80932,7 +81979,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81181,7 +82231,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81430,7 +82483,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81710,7 +82766,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81959,7 +83018,10 @@ export type components = { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -83921,15 +84983,15 @@ export type components = { }; }; }; - /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - readonly package_es_list_error: { + /** @description A header with no content is returned. */ + readonly no_content: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description A header with no content is returned. */ - readonly no_content: { + /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ + readonly package_es_list_error: { headers: { readonly [name: string]: unknown; }; @@ -84130,6 +85192,8 @@ export type components = { readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description The unique identifier of the code security configuration. */ + readonly "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ readonly "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -84171,6 +85235,9 @@ export type components = { readonly "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ readonly "custom-property-name": string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + readonly "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly "repository-name-in-query": number; /** @description The time period to filter by. @@ -84307,8 +85374,6 @@ export type components = { readonly "asset-id": number; /** @description The unique identifier of the release. */ readonly "release-id": number; - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - readonly "ref-in-query": string; /** @description The unique identifier of the tag protection. */ readonly "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -84510,13 +85575,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"] & { + readonly "application/json": components["schemas"]["integration"] & ({ readonly client_id: string; readonly client_secret: string; readonly webhook_secret: string | null; readonly pem: string; + } & { readonly [key: string]: unknown; - }; + }); }; }; readonly 404: components["responses"]["not_found"]; @@ -85244,7 +86310,7 @@ export interface operations { }; content: { readonly "application/json": { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; }; @@ -85276,7 +86342,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ + /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ readonly total_seats?: number; readonly seats?: readonly components["schemas"]["copilot-seat-details"][]; }; @@ -85540,7 +86606,7 @@ export interface operations { readonly [key: string]: { /** @description Content of the file */ readonly content: string; - } | undefined; + }; }; readonly public?: boolean | ("true" | "false"); }; @@ -85708,12 +86774,12 @@ export interface operations { * } */ readonly files?: { - readonly [key: string]: ({ + readonly [key: string]: { /** @description The new content of the file. */ readonly content?: string; /** @description The new filename for the file. */ readonly filename?: string | null; - } | null) | undefined; + } | null; }; } | null; }; @@ -87009,41 +88075,71 @@ export interface operations { readonly web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ readonly blog?: string; - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot security updates is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** @description Whether dependency graph is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly dependency_graph_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ readonly secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -88300,6 +89396,53 @@ export interface operations { }; }; }; + readonly "orgs/list-attestations": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + readonly subject_digest: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly attestations?: readonly { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + readonly bundle?: { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly [key: string]: unknown; + }; + readonly dsseEnvelope?: { + readonly [key: string]: unknown; + }; + }; + readonly repository_id?: number; + }[]; + }; + }; + }; + }; + }; readonly "orgs/list-blocked-users": { readonly parameters: { readonly query?: { @@ -88454,6 +89597,435 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-security/get-configurations-for-org": { + readonly parameters: { + readonly query?: { + /** @description The target type of the code security configuration */ + readonly target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/create-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name: string; + /** @description A description of the code security configuration */ + readonly description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + }; + }; + }; + readonly responses: { + /** @description Successfully created code security configuration */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + readonly "code-security/get-default-configurations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/detach-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/get-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/delete-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/update-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name?: string; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + }; + }; + }; + readonly responses: { + /** @description Response when a configuration is updated */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "code-security/attach-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + readonly scope: "all" | "public" | "private_or_internal" | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + readonly 202: components["responses"]["accepted"]; + }; + }; + readonly "code-security/set-configuration-as-default": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + readonly responses: { + /** @description Default successfully changed. */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/get-repositories-for-configuration": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + readonly status?: string; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "codespaces/list-in-organization": { readonly parameters: { readonly query?: { @@ -90830,31 +92402,6 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-organization-fine-grained-permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; readonly "orgs/list-org-roles": { readonly parameters: { readonly query?: never; @@ -90885,43 +92432,6 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/create-custom-organization-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the custom role. */ - readonly name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - readonly description?: string; - /** @description A list of additional permissions included in this role. */ - readonly permissions: readonly string[]; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["organization-role"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; readonly "orgs/revoke-all-org-roles-team": { readonly parameters: { readonly query?: never; @@ -91123,68 +92633,6 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/delete-custom-organization-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "orgs/patch-custom-organization-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the custom role. */ - readonly name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - readonly description?: string; - /** @description A list of additional permissions included in this role. */ - readonly permissions?: readonly string[]; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["organization-role"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; readonly "orgs/list-org-role-teams": { readonly parameters: { readonly query?: { @@ -92560,7 +94008,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -92590,6 +94039,9 @@ export interface operations { readonly "repos/get-org-rule-suites": { readonly parameters: { readonly query?: { + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + readonly ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. @@ -92705,7 +94157,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -92888,13 +94341,6 @@ export interface operations { }; content?: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - readonly 409: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; }; }; readonly "orgs/remove-security-manager-team": { @@ -94162,10 +95608,7 @@ export interface operations { readonly requestBody?: { readonly content: { readonly "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ readonly permission?: string; }; }; @@ -95185,6 +96628,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + readonly secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + readonly status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -97610,6 +99058,101 @@ export interface operations { }; }; }; + readonly "repos/create-attestation": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + readonly bundle: { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly [key: string]: unknown; + }; + readonly dsseEnvelope?: { + readonly [key: string]: unknown; + }; + }; + }; + }; + }; + readonly responses: { + /** @description response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description The ID of the attestation. */ + readonly id?: number; + }; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/list-attestations": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + readonly subject_digest: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly attestations?: readonly { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + readonly bundle?: { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly [key: string]: unknown; + }; + readonly dsseEnvelope?: { + readonly [key: string]: unknown; + }; + }; + readonly repository_id?: number; + }[]; + }; + }; + }; + }; + }; readonly "repos/list-autolinks": { readonly parameters: { readonly query?: never; @@ -97745,7 +99288,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -97754,7 +99297,7 @@ export interface operations { readonly "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -99143,15 +100686,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ readonly identifier: string; }[]; - } & ({ + } & (({ /** @enum {unknown} */ readonly status: "completed"; + } & { readonly [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ readonly status?: "queued" | "in_progress"; + } & { readonly [key: string]: unknown; - }); + })); }; }; readonly responses: { @@ -99288,15 +100833,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ readonly identifier: string; }[]; - } | { + } | ({ /** @enum {unknown} */ readonly status?: "completed"; + } & { readonly [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ readonly status?: "queued" | "in_progress"; + } & { readonly [key: string]: unknown; - }; + }); }; }; readonly responses: { @@ -102320,7 +103867,10 @@ export interface operations { */ readonly state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ readonly target_url?: string; @@ -103428,7 +104978,7 @@ export interface operations { readonly message: string; /** @description The SHA of the tree object this commit points to */ readonly tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ readonly parents?: readonly string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ readonly author?: { @@ -103805,8 +105355,7 @@ export interface operations { readonly content?: string; }[]; /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - * */ + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ readonly base_tree?: string; }; }; @@ -109216,7 +110765,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -109246,7 +110796,8 @@ export interface operations { readonly "repos/get-repo-rule-suites": { readonly parameters: { readonly query?: { - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ readonly ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -109372,7 +110923,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -115159,6 +116711,30 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "users/get-by-id": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description account_id parameter */ + readonly account_id: components["parameters"]["account-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "users/list": { readonly parameters: { readonly query?: { @@ -115211,6 +116787,60 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "users/list-attestations": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The handle for the GitHub user account. */ + readonly username: components["parameters"]["username"]; + /** @description Subject Digest */ + readonly subject_digest: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly attestations?: readonly { + readonly bundle?: components["schemas"]["sigstore-bundle-0"]; + readonly repository_id?: number; + }[]; + }; + }; + }; + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "packages/list-docker-migration-conflicting-packages-for-user": { readonly parameters: { readonly query?: never; diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 9df2630f0..a69166261 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -410,7 +410,8 @@ export interface paths { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ readonly get: operations["apps/get-by-slug"]; readonly put?: never; @@ -610,10 +611,15 @@ export interface paths { }; /** * List all Copilot seat assignments for an enterprise - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -636,7 +642,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -720,7 +727,8 @@ export interface paths { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-public-events"]; readonly put?: never; @@ -752,7 +760,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ readonly get: operations["activity/get-feeds"]; readonly put?: never; @@ -780,7 +789,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ readonly post: operations["gists/create"]; readonly delete?: never; @@ -1120,10 +1130,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1365,7 +1373,8 @@ export interface paths { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ readonly get: operations["meta/get"]; readonly put?: never; @@ -1383,7 +1392,11 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-public-events-for-repo-network"]; readonly put?: never; readonly post?: never; @@ -1510,7 +1523,8 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ readonly get: operations["orgs/list"]; readonly put?: never; @@ -1536,17 +1550,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -1569,20 +1572,13 @@ export interface paths { readonly head?: never; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -2356,6 +2352,30 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/attestations/{subject_digest}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly get: operations["orgs/list-attestations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/blocks": { readonly parameters: { readonly query?: never; @@ -2428,6 +2448,205 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/code-security/configurations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configurations-for-org"]; + readonly put?: never; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly post: operations["code-security/create-configuration"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/defaults": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-default-configurations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/detach": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly delete: operations["code-security/detach-configuration"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configuration"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly delete: operations["code-security/delete-configuration"]; + readonly options?: never; + readonly head?: never; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly patch: operations["code-security/update-configuration"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly post: operations["code-security/attach-configuration"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly put: operations["code-security/set-configuration-as-default"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + readonly get: operations["code-security/get-repositories-for-configuration"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/codespaces": { readonly parameters: { readonly query?: never; @@ -2656,7 +2875,8 @@ export interface paths { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -2684,7 +2904,8 @@ export interface paths { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. * Only organization owners can view assigned seats. @@ -2711,7 +2932,8 @@ export interface paths { readonly put?: never; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2722,12 +2944,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2757,7 +2982,8 @@ export interface paths { readonly put?: never; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2768,12 +2994,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ readonly post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2801,7 +3030,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3021,7 +3251,11 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-public-org-events"]; readonly put?: never; readonly post?: never; @@ -3422,10 +3656,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -3562,7 +3794,8 @@ export interface paths { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * @@ -3734,35 +3967,6 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/orgs/{org}/organization-fine-grained-permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly get: operations["orgs/list-organization-fine-grained-permissions"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; readonly "/orgs/{org}/organization-roles": { readonly parameters: { readonly query?: never; @@ -3772,7 +3976,7 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3783,18 +3987,7 @@ export interface paths { */ readonly get: operations["orgs/list-org-roles"]; readonly put?: never; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly post: operations["orgs/create-custom-organization-role"]; + readonly post?: never; readonly delete?: never; readonly options?: never; readonly head?: never; @@ -3813,7 +4006,7 @@ export interface paths { readonly post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3835,7 +4028,7 @@ export interface paths { readonly get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3845,7 +4038,7 @@ export interface paths { readonly post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3869,7 +4062,7 @@ export interface paths { readonly post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3891,7 +4084,7 @@ export interface paths { readonly get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3901,7 +4094,7 @@ export interface paths { readonly post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3922,7 +4115,7 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3934,33 +4127,10 @@ export interface paths { readonly get: operations["orgs/get-org-role"]; readonly put?: never; readonly post?: never; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly delete: operations["orgs/delete-custom-organization-role"]; + readonly delete?: never; readonly options?: never; readonly head?: never; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - readonly patch: operations["orgs/patch-custom-organization-role"]; + readonly patch?: never; readonly trace?: never; }; readonly "/orgs/{org}/organization-roles/{role_id}/teams": { @@ -3972,7 +4142,7 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3996,7 +4166,7 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -4544,7 +4714,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ readonly get: operations["repos/list-for-org"]; readonly put?: never; @@ -4868,7 +5039,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ readonly get: operations["teams/get-by-name"]; readonly put?: never; @@ -4879,7 +5051,8 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ readonly delete: operations["teams/delete-in-org"]; readonly options?: never; @@ -4888,7 +5061,8 @@ export interface paths { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ readonly patch: operations["teams/update-in-org"]; readonly trace?: never; @@ -4904,7 +5078,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4916,7 +5091,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4938,7 +5114,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4949,7 +5126,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4960,7 +5138,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4978,7 +5157,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4990,7 +5170,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5012,7 +5193,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5023,7 +5205,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5034,7 +5217,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5052,7 +5236,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5064,7 +5249,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5087,7 +5273,8 @@ export interface paths { readonly post?: never; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -5110,7 +5297,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5122,7 +5310,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5145,7 +5334,8 @@ export interface paths { readonly post?: never; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -5168,7 +5358,8 @@ export interface paths { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ readonly get: operations["teams/list-pending-invitations-in-org"]; readonly put?: never; @@ -5214,10 +5405,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -5228,13 +5420,15 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ readonly put: operations["teams/add-or-update-membership-for-user-in-org"]; readonly post?: never; @@ -5244,9 +5438,11 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ readonly delete: operations["teams/remove-membership-for-user-in-org"]; readonly options?: never; @@ -5265,7 +5461,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ readonly get: operations["teams/list-projects-in-org"]; readonly put?: never; @@ -5287,14 +5484,16 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ readonly get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ readonly put: operations["teams/add-or-update-project-permissions-in-org"]; readonly post?: never; @@ -5302,7 +5501,8 @@ export interface paths { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ readonly delete: operations["teams/remove-project-in-org"]; readonly options?: never; @@ -5321,7 +5521,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ readonly get: operations["teams/list-repos-in-org"]; readonly put?: never; @@ -5349,14 +5550,16 @@ export interface paths { * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -5366,7 +5569,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly delete: operations["teams/remove-repo-in-org"]; readonly options?: never; @@ -5385,7 +5589,8 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ readonly get: operations["teams/list-child-in-org"]; readonly put?: never; @@ -5407,7 +5612,11 @@ export interface paths { readonly put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * @@ -5650,7 +5859,8 @@ export interface paths { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -5663,7 +5873,8 @@ export interface paths { * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ readonly get: operations["rate-limit/get"]; readonly put?: never; @@ -5685,7 +5896,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ readonly get: operations["repos/get"]; readonly put?: never; @@ -6605,8 +6817,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -7193,6 +7405,54 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/attestations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly post: operations["repos/create-attestation"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/attestations/{subject_digest}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly get: operations["repos/list-attestations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/autolinks": { readonly parameters: { readonly query?: never; @@ -7327,9 +7587,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ readonly put: operations["repos/update-branch-protection"]; readonly post?: never; @@ -7402,7 +7664,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ readonly patch: operations["repos/update-pull-request-review-protection"]; readonly trace?: never; @@ -7420,7 +7683,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ readonly get: operations["repos/get-commit-signature-protection"]; readonly put?: never; @@ -7518,7 +7782,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ readonly get: operations["repos/get-access-restrictions"]; readonly put?: never; @@ -7680,7 +7945,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -7710,7 +7976,8 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ readonly post: operations["checks/create"]; readonly delete?: never; @@ -7730,7 +7997,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7744,7 +8012,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7810,7 +8079,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7853,7 +8123,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7877,7 +8148,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -8007,8 +8279,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8660,7 +8932,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -8800,7 +9073,8 @@ export interface paths { readonly post?: never; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -8952,7 +9226,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -9009,7 +9284,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -9035,7 +9311,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -9236,7 +9513,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -9252,7 +9530,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ readonly delete: operations["repos/delete-file"]; readonly options?: never; @@ -9680,7 +9959,8 @@ export interface paths { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -9691,9 +9971,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -9818,7 +10100,9 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -10039,8 +10323,8 @@ export interface paths { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - * + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-repo-events"]; readonly put?: never; @@ -10065,9 +10349,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ readonly post: operations["repos/create-fork"]; readonly delete?: never; @@ -10233,7 +10519,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -10257,7 +10544,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ readonly get: operations["git/get-ref"]; readonly put?: never; @@ -10445,8 +10733,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ readonly get: operations["git/get-tree"]; readonly put?: never; @@ -10628,7 +10916,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ readonly post: operations["repos/test-push-webhook"]; readonly delete?: never; @@ -10649,7 +10938,8 @@ export interface paths { * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -10692,8 +10982,8 @@ export interface paths { * Importing into a GitHub repository with GitHub Actions enabled is not supported and will * return a status `422 Unprocessable Entity` response. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly put: operations["migrations/start-import"]; readonly post?: never; @@ -10702,8 +10992,8 @@ export interface paths { * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly delete: operations["migrations/cancel-import"]; readonly options?: never; @@ -10718,7 +11008,8 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/update-import"]; readonly trace?: never; @@ -10737,7 +11028,8 @@ export interface paths { * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-commit-authors"]; readonly put?: never; @@ -10767,8 +11059,8 @@ export interface paths { * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/map-commit-author"]; readonly trace?: never; @@ -10785,8 +11077,8 @@ export interface paths { * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-large-files"]; readonly put?: never; @@ -10819,8 +11111,8 @@ export interface paths { * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/set-lfs-preference"]; readonly trace?: never; @@ -10924,10 +11216,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11066,7 +11356,8 @@ export interface paths { readonly post?: never; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -11132,10 +11423,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11391,7 +11680,8 @@ export interface paths { readonly post?: never; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ @@ -12134,7 +12424,8 @@ export interface paths { readonly post?: never; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -12337,8 +12628,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12438,7 +12729,8 @@ export interface paths { * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -12544,9 +12836,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12786,9 +13077,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ readonly get: operations["repos/get-release"]; readonly put?: never; @@ -12882,7 +13172,8 @@ export interface paths { readonly post?: never; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -13217,7 +13508,8 @@ export interface paths { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ readonly post: operations["security-advisories/create-fork"]; readonly delete?: never; @@ -13259,12 +13551,10 @@ export interface paths { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ readonly get: operations["repos/get-code-frequency-stats"]; readonly put?: never; @@ -13312,7 +13602,8 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ readonly get: operations["repos/get-contributors-stats"]; readonly put?: never; @@ -13470,8 +13761,8 @@ export interface paths { /** * Deprecated - List tag protection states for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13482,8 +13773,8 @@ export interface paths { /** * Deprecated - Create a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13508,8 +13799,8 @@ export interface paths { /** * Deprecated - Delete a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13532,7 +13823,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ readonly get: operations["repos/download-tarball-archive"]; readonly put?: never; @@ -13728,7 +14021,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ readonly get: operations["repos/download-zipball-archive"]; readonly put?: never; @@ -13871,7 +14165,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ readonly get: operations["search/issues-and-pull-requests"]; readonly put?: never; @@ -14006,7 +14301,8 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ readonly get: operations["teams/get-legacy"]; readonly put?: never; @@ -14014,7 +14310,8 @@ export interface paths { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14026,11 +14323,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ readonly patch: operations["teams/update-legacy"]; readonly trace?: never; @@ -14045,7 +14344,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14056,7 +14356,8 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14081,7 +14382,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14093,7 +14395,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14105,7 +14408,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14124,7 +14428,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14135,7 +14440,8 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14160,7 +14466,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14172,7 +14479,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14184,7 +14492,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14203,7 +14512,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14214,7 +14524,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14239,7 +14550,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14250,7 +14562,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14275,7 +14588,8 @@ export interface paths { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14298,7 +14612,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14339,7 +14654,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -14356,7 +14672,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ readonly delete: operations["teams/remove-member-legacy"]; readonly options?: never; @@ -14374,7 +14691,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14389,13 +14707,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -14406,13 +14726,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ readonly delete: operations["teams/remove-membership-for-user-legacy"]; readonly options?: never; @@ -14430,7 +14752,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14453,7 +14776,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14461,7 +14785,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14470,7 +14795,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14490,7 +14816,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ readonly get: operations["teams/list-repos-legacy"]; readonly put?: never; @@ -14511,9 +14838,11 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ @@ -14521,7 +14850,8 @@ export interface paths { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14532,7 +14862,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -14552,7 +14883,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ readonly get: operations["teams/list-child-legacy"]; readonly put?: never; @@ -15304,10 +15636,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -16071,6 +16401,30 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/user/{account_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + readonly get: operations["users/get-by-id"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/users": { readonly parameters: { readonly query?: never; @@ -16117,6 +16471,30 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/users/{username}/attestations/{subject_digest}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + readonly get: operations["users/list-attestations"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/users/{username}/docker/conflicts": { readonly parameters: { readonly query?: never; @@ -16149,6 +16527,9 @@ export interface paths { /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-events-for-authenticated-user"]; readonly put?: never; @@ -16169,6 +16550,9 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-org-events-for-authenticated-user"]; readonly put?: never; @@ -16186,7 +16570,11 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-public-events-for-user"]; readonly put?: never; readonly post?: never; @@ -16570,7 +16958,11 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ readonly get: operations["activity/list-received-events-for-user"]; readonly put?: never; @@ -16588,7 +16980,11 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ readonly get: operations["activity/list-received-public-events-for-user"]; readonly put?: never; readonly post?: never; @@ -16918,7 +17314,10 @@ export interface components { readonly email?: string | null; /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; @@ -17104,7 +17503,10 @@ export interface components { readonly email?: string | null; /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; @@ -17222,7 +17624,8 @@ export interface components { readonly metadata?: string; readonly contents?: string; readonly deployments?: string; - readonly [key: string]: string | undefined; + } & { + readonly [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -17866,6 +18269,7 @@ export interface components { */ readonly repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -18266,6 +18670,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ readonly authorization: { + /** Format: int64 */ readonly id: number; /** Format: uri */ readonly url: string; @@ -18954,6 +19359,7 @@ export interface components { * @description Group of enterprise owners and/or members */ readonly "enterprise-team": { + /** Format: int64 */ readonly id: number; readonly name: string; readonly slug: string; @@ -19037,7 +19443,7 @@ export interface components { /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ readonly total_active_chat_users?: number; /** @description Breakdown of Copilot code completions usage by language and editor */ - readonly breakdown: readonly { + readonly breakdown: readonly ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ readonly language?: string; /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ @@ -19052,8 +19458,9 @@ export interface components { readonly lines_accepted?: number; /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ readonly active_users?: number; + } & { readonly [key: string]: unknown; - }[] | null; + })[] | null; }; /** @description The security alert number. */ readonly "alert-number": number; @@ -19186,6 +19593,7 @@ export interface components { */ readonly "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -19658,7 +20066,8 @@ export interface components { readonly metadata?: string; readonly contents?: string; readonly deployments?: string; - readonly [key: string]: string | undefined; + } & { + readonly [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -19962,7 +20371,7 @@ export interface components { readonly language?: string; readonly raw_url?: string; readonly size?: number; - } | undefined; + }; }; readonly public: boolean; /** Format: date-time */ @@ -19985,6 +20394,7 @@ export interface components { */ readonly "public-user": { readonly login: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; /** Format: uri */ @@ -20109,7 +20519,7 @@ export interface components { readonly language?: string; readonly raw_url?: string; readonly size?: number; - } | undefined; + }; }; readonly public: boolean; /** Format: date-time */ @@ -20135,7 +20545,7 @@ export interface components { readonly git_push_url?: string; readonly html_url?: string; readonly files?: { - readonly [key: string]: ({ + readonly [key: string]: { readonly filename?: string; readonly type?: string; readonly language?: string; @@ -20143,7 +20553,7 @@ export interface components { readonly size?: number; readonly truncated?: boolean; readonly content?: string; - } | null) | undefined; + } | null; }; readonly public?: boolean; readonly created_at?: string; @@ -20492,13 +20902,20 @@ export interface components { /** @enum {string} */ readonly status?: "enabled" | "disabled"; }; + readonly secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + readonly status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ readonly "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; @@ -20878,47 +21295,60 @@ export interface components { /** @example false */ readonly web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ readonly secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -21010,7 +21440,8 @@ export interface components { readonly verified_allowed?: boolean; /** @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. */ + * > [!NOTE] + * > The `patterns_allowed` setting only applies to public repositories. */ readonly patterns_allowed?: readonly string[]; }; /** @@ -21235,7 +21666,7 @@ export interface components { * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; + readonly "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ readonly "code-scanning-alert-dismissed-comment": string | null; readonly "code-scanning-alert-rule-summary": { @@ -21243,8 +21674,6 @@ export interface components { readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; - /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -21257,6 +21686,8 @@ export interface components { readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; + /** @description A set of tags applicable for the rule. */ + readonly tags?: readonly string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-version": string | null; @@ -21321,6 +21752,102 @@ export interface components { readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; readonly repository: components["schemas"]["simple-repository"]; }; + /** @description A code security configuration */ + readonly "code-security-configuration": { + /** @description The ID of the code security configuration */ + readonly id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name?: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + readonly target_type?: "global" | "organization"; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + readonly url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + readonly html_url?: string; + /** Format: date-time */ + readonly created_at?: string; + /** Format: date-time */ + readonly updated_at?: string; + }; + /** @description A list of default code security configurations */ + readonly "code-security-default-configurations": readonly { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + readonly "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + readonly repository?: components["schemas"]["simple-repository"]; + }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -21368,7 +21895,10 @@ export interface components { * @description A codespace. */ readonly codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** * @description Automatically generated name of this codespace. @@ -21622,6 +22152,7 @@ export interface components { * @enum {string} */ readonly seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + } & { readonly [key: string]: unknown; }; /** @@ -21670,7 +22201,10 @@ export interface components { * @description Minimal Repository */ readonly "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; @@ -21922,6 +22456,7 @@ export interface components { * @description Organization Invitation */ readonly "organization-invitation": { + /** Format: int64 */ readonly id: number; readonly login: string | null; readonly email: string | null; @@ -22063,7 +22598,10 @@ export interface components { * @description A migration. */ readonly migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ readonly id: number; readonly owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -22101,20 +22639,15 @@ export interface components { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ readonly exclude?: readonly string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - readonly "organization-fine-grained-permission": { - readonly name: string; - readonly description: string; - }; /** * Organization Role * @description Organization roles */ readonly "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ readonly id: number; /** @description The name of the role. */ readonly name: string; @@ -22374,13 +22907,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ readonly permissions: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ @@ -22410,13 +22943,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ readonly permissions: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -22552,6 +23085,7 @@ export interface components { */ readonly "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -22927,7 +23461,10 @@ export interface components { * @description Full Repository */ readonly "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; @@ -23301,6 +23838,11 @@ export interface components { readonly name: string; /** @description The values to match for the repository property */ readonly property_values: readonly string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + readonly source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -23356,6 +23898,36 @@ export interface components { /** @enum {string} */ readonly type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + readonly "repository-rule-merge-queue": { + /** @enum {string} */ + readonly type: "merge_queue"; + readonly parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + readonly check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + readonly grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + readonly max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + readonly max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + readonly merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + readonly min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + readonly min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -23414,6 +23986,8 @@ export interface components { /** @enum {string} */ readonly type: "required_status_checks"; readonly parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + readonly do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ readonly required_status_checks: readonly components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -23565,6 +24139,8 @@ export interface components { /** @enum {string} */ readonly type: "workflows"; readonly parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + readonly do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ readonly workflows: readonly components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -23603,7 +24179,7 @@ export interface components { * Repository Rule * @description A repository rule. */ - readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { /** @enum {string} */ readonly type: "file_path_restriction"; readonly parameters?: { @@ -23644,7 +24220,8 @@ export interface components { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -24688,6 +25265,7 @@ export interface components { */ readonly url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -25106,6 +25684,7 @@ export interface components { }; /** Pull Request Minimal */ readonly "pull-request-minimal": { + /** Format: int64 */ readonly id: number; readonly number: number; readonly url: string; @@ -25113,6 +25692,7 @@ export interface components { readonly ref: string; readonly sha: string; readonly repo: { + /** Format: int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -25122,6 +25702,7 @@ export interface components { readonly ref: string; readonly sha: string; readonly repo: { + /** Format: int64 */ readonly id: number; readonly url: string; readonly name: string; @@ -25391,6 +25972,7 @@ export interface components { readonly "pending-deployment": { readonly environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -25440,6 +26022,7 @@ export interface components { */ readonly url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -25759,6 +26342,7 @@ export interface components { readonly apps_url: string; readonly users: readonly { readonly login?: string; + /** Format: int64 */ readonly id?: number; readonly node_id?: string; readonly avatar_url?: string; @@ -26019,8 +26603,8 @@ export interface components { }; readonly verification?: components["schemas"]["verification"]; }; - readonly author: components["schemas"]["nullable-simple-user"]; - readonly committer: components["schemas"]["nullable-simple-user"]; + readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; readonly parents: readonly { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ readonly sha: string; @@ -26919,7 +27503,10 @@ export interface components { readonly collaborator: { /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; readonly email?: string | null; readonly name?: string | null; @@ -26994,6 +27581,7 @@ export interface components { */ readonly "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -27030,7 +27618,10 @@ export interface components { readonly "nullable-collaborator": { /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; readonly email?: string | null; readonly name?: string | null; @@ -27178,7 +27769,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ readonly url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; @@ -27896,6 +28490,11 @@ export interface components { * @example NOASSERTION */ readonly supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + readonly copyrightText?: string; readonly externalRefs?: readonly { /** * @description The category of reference to an external resource this reference refers to. @@ -27921,7 +28520,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ readonly metadata: { - readonly [key: string]: ((string | number | boolean) | null) | undefined; + readonly [key: string]: (string | number | boolean) | null; }; readonly dependency: { /** @@ -27964,7 +28563,7 @@ export interface components { readonly metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ readonly resolved?: { - readonly [key: string]: components["schemas"]["dependency"] | undefined; + readonly [key: string]: components["schemas"]["dependency"]; }; }; /** @@ -28022,7 +28621,7 @@ export interface components { readonly metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ readonly manifests?: { - readonly [key: string]: components["schemas"]["manifest"] | undefined; + readonly [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time @@ -28041,7 +28640,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ readonly url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ readonly node_id: string; @@ -28125,6 +28727,7 @@ export interface components { */ readonly environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -29159,6 +29762,7 @@ export interface components { readonly label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ readonly id: number; @@ -29175,14 +29779,20 @@ export interface components { * @example bug */ readonly name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ readonly description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ readonly color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ readonly default: boolean; }; /** @@ -29393,11 +30003,13 @@ export interface components { */ readonly url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ readonly pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -29629,7 +30241,7 @@ export interface components { * @description Language */ readonly language: { - readonly [key: string]: number | undefined; + readonly [key: string]: number; }; /** * License Content @@ -29971,7 +30583,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ readonly url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ readonly node_id: string; @@ -30241,6 +30856,7 @@ export interface components { readonly gravatar_id: string | null; /** Format: uri */ readonly html_url: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; readonly login: string; @@ -30416,6 +31032,7 @@ export interface components { readonly gravatar_id: string | null; /** Format: uri */ readonly html_url: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; readonly login: string; @@ -30500,6 +31117,7 @@ export interface components { */ readonly "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -30553,9 +31171,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ readonly url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ readonly pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ readonly id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ readonly node_id: string; @@ -30757,7 +31381,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); readonly "secret-scanning-alert": { readonly number?: components["schemas"]["alert-number"]; readonly created_at?: components["schemas"]["alert-created-at"]; @@ -31632,6 +32256,7 @@ export interface components { */ readonly "user-search-result-item": { readonly login: string; + /** Format: int64 */ readonly id: number; readonly node_id: string; /** Format: uri */ @@ -31685,7 +32310,10 @@ export interface components { readonly "private-user": { /** @example octocat */ readonly login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** @example MDQ6VXNlcjE= */ readonly node_id: string; @@ -31901,7 +32529,10 @@ export interface components { * @description A codespace. */ readonly "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ readonly id: number; /** * @description Automatically generated name of this codespace. @@ -32067,7 +32698,10 @@ export interface components { * @description A unique encryption key */ readonly "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ readonly id: number; /** @example Octocat's GPG Key */ readonly name?: string | null; @@ -32103,6 +32737,7 @@ export interface components { * } * ] */ readonly subkeys: readonly { + /** Format: int64 */ readonly id?: number; readonly primary_key_id?: number; readonly key_id?: string; @@ -32144,6 +32779,7 @@ export interface components { */ readonly key: { readonly key: string; + /** Format: int64 */ readonly id: number; readonly url: string; readonly title: string; @@ -32223,6 +32859,45 @@ export interface components { readonly starred_at: string; readonly repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + readonly "sigstore-bundle-0": { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly x509CertificateChain?: { + readonly certificates?: readonly { + readonly rawBytes?: string; + }[]; + }; + readonly tlogEntries?: readonly { + readonly logIndex?: string; + readonly logId?: { + readonly keyId?: string; + }; + readonly kindVersion?: { + readonly kind?: string; + readonly version?: string; + }; + readonly integratedTime?: string; + readonly inclusionPromise?: { + readonly signedEntryTimestamp?: string; + }; + readonly inclusionProof?: string | null; + readonly canonicalizedBody?: string; + }[]; + readonly timestampVerificationData?: string | null; + }; + readonly dsseEnvelope?: { + readonly payload?: string; + readonly payloadType?: string; + readonly signatures?: readonly { + readonly sig?: string; + readonly keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -32246,7 +32921,6 @@ export interface components { * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." - * */ readonly "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -32356,6 +33030,7 @@ export interface components { */ readonly "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -32946,6 +33621,13 @@ export interface components { readonly ignore_approvals_from_contributors: boolean; /** @enum {string} */ readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + readonly lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + readonly lock_allows_fork_sync?: boolean; /** @enum {string} */ readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; readonly name: string; @@ -33197,6 +33879,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33267,6 +33950,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33410,6 +34094,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33430,6 +34115,7 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly labels?: readonly components["schemas"]["label"][]; }; readonly webhooks_comment: { /** @@ -33479,6 +34165,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -33607,6 +34294,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -34024,6 +34712,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -34505,6 +35194,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -34702,6 +35392,7 @@ export interface components { */ readonly "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -35301,6 +35992,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -35333,37 +36025,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ readonly permissions_added: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ readonly permissions_upgraded: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ readonly permissions_result: { readonly organization?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repository?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly other?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; /** @@ -35633,6 +36325,43 @@ export interface components { readonly duration?: number | null; readonly start_date?: string | null; }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + readonly "projects-v2-status-update": { + readonly id: number; + readonly node_id: string; + readonly project_node_id?: string; + readonly creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly updated_at: string; + /** @enum {string|null} */ + readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @example 2022-04-28 + */ + readonly start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + readonly target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + readonly body?: string | null; + }; /** @description The pull request number. */ readonly webhooks_number: number; readonly "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -35982,7 +36711,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -36164,6 +36896,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -36322,7 +37055,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -36504,6 +37240,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -36840,6 +37577,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -36985,6 +37723,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -37057,6 +37796,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -37780,6 +38520,20 @@ export interface components { /** @enum {string} */ readonly from: "off" | "non_admins" | "everyone"; }; + readonly lock_branch_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + readonly lock_allows_fork_sync?: { + readonly from: boolean | null; + }; + readonly pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + readonly require_last_push_approval?: { + readonly from: boolean | null; + }; readonly required_status_checks?: { readonly from: readonly string[]; }; @@ -39327,6 +40081,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -39380,7 +40135,7 @@ export interface components { readonly definition: components["schemas"]["org-custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property deleted event */ @@ -39393,7 +40148,7 @@ export interface components { }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property updated event */ @@ -39403,7 +40158,7 @@ export interface components { readonly definition: components["schemas"]["org-custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; /** Custom property values updated event */ @@ -42056,7 +42811,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -42551,6 +43309,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -42960,6 +43719,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -43080,6 +43840,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -43490,6 +44251,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -43610,6 +44372,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -44021,6 +44784,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -44141,6 +44905,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -44568,6 +45333,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -44635,6 +45401,7 @@ export interface components { readonly gists_url?: string; readonly gravatar_id?: string; readonly html_url?: string; + /** Format: int64 */ readonly id?: number; readonly login?: string; readonly node_id?: string; @@ -45047,6 +45814,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -45467,6 +46235,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -45899,6 +46668,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -46320,6 +47090,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -46742,6 +47513,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -47162,6 +47934,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -47582,6 +48355,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -47721,7 +48495,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -48238,6 +49015,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -48669,6 +49447,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -49088,6 +49867,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -49230,7 +50010,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -49786,6 +50569,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -50447,11 +51231,11 @@ export interface components { }; readonly platform?: string; readonly metadata?: { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; readonly repo?: string; readonly dependencies?: readonly { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }[]; readonly commit_oid?: string; }; @@ -51556,6 +52340,57 @@ export interface components { readonly projects_v2: components["schemas"]["projects-v2"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; + /** Projects v2 Status Update Created Event */ + readonly "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + readonly action: "created"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Deleted Event */ + readonly "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Edited Event */ + readonly "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes?: { + readonly body?: { + readonly from?: string | null; + readonly to?: string | null; + }; + readonly status?: { + /** @enum {string|null} */ + readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** @enum {string|null} */ + readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + }; + readonly start_date?: { + /** Format: date */ + readonly from?: string | null; + /** Format: date */ + readonly to?: string | null; + }; + readonly target_date?: { + /** Format: date */ + readonly from?: string | null; + /** Format: date */ + readonly to?: string | null; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; /** public event */ readonly "webhook-public": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -51871,7 +52706,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -52053,6 +52891,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -52211,7 +53050,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -52393,6 +53235,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -52729,6 +53572,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -53059,7 +53903,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -53241,6 +54088,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -53399,7 +54247,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -53581,6 +54432,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -53917,6 +54769,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -54248,7 +55101,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -54430,6 +55286,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -54770,6 +55627,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -55106,6 +55964,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -55473,7 +56332,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -55655,6 +56517,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -55813,7 +56676,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -55995,6 +56861,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -56331,6 +57198,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -56693,7 +57561,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -56875,6 +57746,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -57033,7 +57905,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -57215,6 +58090,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -57551,6 +58427,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -57882,7 +58759,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -58064,6 +58944,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -58222,7 +59103,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -58404,6 +59288,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -58740,6 +59625,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -59070,7 +59956,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -59252,6 +60141,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -59410,7 +60300,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -59592,6 +60485,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -59928,6 +60822,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -60128,6 +61023,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -60448,7 +61344,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -60630,6 +61529,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -60781,7 +61681,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -60963,6 +61866,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -61248,6 +62152,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -61576,7 +62481,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -61758,6 +62666,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -61909,7 +62818,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -62091,6 +63003,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -62376,6 +63289,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -62705,7 +63619,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -62887,6 +63804,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -63038,7 +63956,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -63220,6 +64141,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -63505,6 +64427,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -63833,7 +64756,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -64015,6 +64941,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -64166,7 +65093,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -64348,6 +65278,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -64633,6 +65564,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -64707,6 +65639,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -65035,7 +65968,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -65176,6 +66112,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -65322,7 +66259,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -65463,6 +66403,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -65748,6 +66689,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -66080,7 +67022,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -66255,6 +67200,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -66413,7 +67359,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -66595,6 +67544,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -66931,6 +67881,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -67297,7 +68248,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -67479,6 +68433,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -67637,7 +68592,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -67819,6 +68777,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -68155,6 +69114,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -68541,7 +69501,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -68723,6 +69686,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -68881,7 +69845,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -69063,6 +70030,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -69399,6 +70367,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -69765,7 +70734,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -69947,6 +70919,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -70105,7 +71078,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -70287,6 +71263,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -70623,6 +71600,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -71006,7 +71984,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -71188,6 +72169,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -71339,7 +72321,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -71521,6 +72506,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -71806,6 +72792,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -72135,7 +73122,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -72278,6 +73268,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -72429,7 +73420,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -72572,6 +73566,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -72857,6 +73852,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -73001,6 +73997,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -73329,7 +74326,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -73472,6 +74472,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -73623,7 +74624,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -73766,6 +74770,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74051,6 +75056,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74195,6 +75201,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74527,7 +75534,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -74709,6 +75719,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -74867,7 +75878,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -75042,6 +76056,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -75378,6 +76393,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -75709,7 +76725,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -75891,6 +76910,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -76049,7 +77069,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -76231,6 +77254,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -76567,6 +77591,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -76898,7 +77923,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -77080,6 +78108,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -77238,7 +78267,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -77413,6 +78445,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -77749,6 +78782,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -78079,7 +79113,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -78261,6 +79298,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -78419,7 +79457,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -78601,6 +79642,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -78937,6 +79979,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -79217,7 +80260,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -80180,6 +81226,7 @@ export interface components { readonly gravatar_id?: string; /** Format: uri */ readonly html_url?: string; + /** Format: int64 */ readonly id: number; readonly login: string; readonly name?: string; @@ -80932,7 +81979,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81181,7 +82231,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81430,7 +82483,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81710,7 +82766,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -81959,7 +83018,10 @@ export interface components { readonly hooks_url: string; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ readonly id: number; readonly is_template?: boolean; /** Format: uri-template */ @@ -83921,15 +84983,15 @@ export interface components { }; }; }; - /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - readonly package_es_list_error: { + /** @description A header with no content is returned. */ + readonly no_content: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description A header with no content is returned. */ - readonly no_content: { + /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ + readonly package_es_list_error: { headers: { readonly [name: string]: unknown; }; @@ -84130,6 +85192,8 @@ export interface components { readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description The unique identifier of the code security configuration. */ + readonly "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ readonly "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -84171,6 +85235,9 @@ export interface components { readonly "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ readonly "custom-property-name": string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + readonly "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly "repository-name-in-query": number; /** @description The time period to filter by. @@ -84307,8 +85374,6 @@ export interface components { readonly "asset-id": number; /** @description The unique identifier of the release. */ readonly "release-id": number; - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - readonly "ref-in-query": string; /** @description The unique identifier of the tag protection. */ readonly "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -84510,13 +85575,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"] & { + readonly "application/json": components["schemas"]["integration"] & ({ readonly client_id: string; readonly client_secret: string; readonly webhook_secret: string | null; readonly pem: string; + } & { readonly [key: string]: unknown; - }; + }); }; }; readonly 404: components["responses"]["not_found"]; @@ -85244,7 +86310,7 @@ export interface operations { }; content: { readonly "application/json": { - readonly [key: string]: string | undefined; + readonly [key: string]: string; }; }; }; @@ -85276,7 +86342,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ + /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ readonly total_seats?: number; readonly seats?: readonly components["schemas"]["copilot-seat-details"][]; }; @@ -85540,7 +86606,7 @@ export interface operations { readonly [key: string]: { /** @description Content of the file */ readonly content: string; - } | undefined; + }; }; readonly public?: boolean | ("true" | "false"); }; @@ -85708,12 +86774,12 @@ export interface operations { * } */ readonly files?: { - readonly [key: string]: ({ + readonly [key: string]: { /** @description The new content of the file. */ readonly content?: string; /** @description The new filename for the file. */ readonly filename?: string | null; - } | null) | undefined; + } | null; }; } | null; }; @@ -87009,41 +88075,71 @@ export interface operations { readonly web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ readonly blog?: string; - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot security updates is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** @description Whether dependency graph is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly dependency_graph_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ readonly secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -88300,6 +89396,53 @@ export interface operations { }; }; }; + readonly "orgs/list-attestations": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + readonly subject_digest: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly attestations?: readonly { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + readonly bundle?: { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly [key: string]: unknown; + }; + readonly dsseEnvelope?: { + readonly [key: string]: unknown; + }; + }; + readonly repository_id?: number; + }[]; + }; + }; + }; + }; + }; readonly "orgs/list-blocked-users": { readonly parameters: { readonly query?: { @@ -88454,6 +89597,435 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-security/get-configurations-for-org": { + readonly parameters: { + readonly query?: { + /** @description The target type of the code security configuration */ + readonly target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/create-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name: string; + /** @description A description of the code security configuration */ + readonly description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + }; + }; + }; + readonly responses: { + /** @description Successfully created code security configuration */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + readonly "code-security/get-default-configurations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/detach-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/get-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/delete-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/update-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name?: string; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + }; + }; + }; + readonly responses: { + /** @description Response when a configuration is updated */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "code-security/attach-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + readonly scope: "all" | "public" | "private_or_internal" | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + readonly 202: components["responses"]["accepted"]; + }; + }; + readonly "code-security/set-configuration-as-default": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + readonly responses: { + /** @description Default successfully changed. */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/get-repositories-for-configuration": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + readonly status?: string; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "codespaces/list-in-organization": { readonly parameters: { readonly query?: { @@ -90830,31 +92402,6 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-organization-fine-grained-permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; readonly "orgs/list-org-roles": { readonly parameters: { readonly query?: never; @@ -90885,43 +92432,6 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/create-custom-organization-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the custom role. */ - readonly name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - readonly description?: string; - /** @description A list of additional permissions included in this role. */ - readonly permissions: readonly string[]; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["organization-role"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; readonly "orgs/revoke-all-org-roles-team": { readonly parameters: { readonly query?: never; @@ -91123,68 +92633,6 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/delete-custom-organization-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "orgs/patch-custom-organization-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the custom role. */ - readonly name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - readonly description?: string; - /** @description A list of additional permissions included in this role. */ - readonly permissions?: readonly string[]; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["organization-role"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; readonly "orgs/list-org-role-teams": { readonly parameters: { readonly query?: { @@ -92560,7 +94008,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -92590,6 +94039,9 @@ export interface operations { readonly "repos/get-org-rule-suites": { readonly parameters: { readonly query?: { + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + readonly ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. @@ -92705,7 +94157,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -92888,13 +94341,6 @@ export interface operations { }; content?: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - readonly 409: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; }; }; readonly "orgs/remove-security-manager-team": { @@ -94162,10 +95608,7 @@ export interface operations { readonly requestBody?: { readonly content: { readonly "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ readonly permission?: string; }; }; @@ -95185,6 +96628,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + readonly secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + readonly status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -97610,6 +99058,101 @@ export interface operations { }; }; }; + readonly "repos/create-attestation": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + readonly bundle: { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly [key: string]: unknown; + }; + readonly dsseEnvelope?: { + readonly [key: string]: unknown; + }; + }; + }; + }; + }; + readonly responses: { + /** @description response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description The ID of the attestation. */ + readonly id?: number; + }; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/list-attestations": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + readonly subject_digest: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly attestations?: readonly { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + readonly bundle?: { + readonly mediaType?: string; + readonly verificationMaterial?: { + readonly [key: string]: unknown; + }; + readonly dsseEnvelope?: { + readonly [key: string]: unknown; + }; + }; + readonly repository_id?: number; + }[]; + }; + }; + }; + }; + }; readonly "repos/list-autolinks": { readonly parameters: { readonly query?: never; @@ -97745,7 +99288,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -97754,7 +99297,7 @@ export interface operations { readonly "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -99143,15 +100686,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ readonly identifier: string; }[]; - } & ({ + } & (({ /** @enum {unknown} */ readonly status: "completed"; + } & { readonly [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ readonly status?: "queued" | "in_progress"; + } & { readonly [key: string]: unknown; - }); + })); }; }; readonly responses: { @@ -99288,15 +100833,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ readonly identifier: string; }[]; - } | { + } | ({ /** @enum {unknown} */ readonly status?: "completed"; + } & { readonly [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ readonly status?: "queued" | "in_progress"; + } & { readonly [key: string]: unknown; - }; + }); }; }; readonly responses: { @@ -102320,7 +103867,10 @@ export interface operations { */ readonly state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ readonly target_url?: string; @@ -103428,7 +104978,7 @@ export interface operations { readonly message: string; /** @description The SHA of the tree object this commit points to */ readonly tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ readonly parents?: readonly string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ readonly author?: { @@ -103805,8 +105355,7 @@ export interface operations { readonly content?: string; }[]; /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - * */ + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ readonly base_tree?: string; }; }; @@ -109216,7 +110765,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -109246,7 +110796,8 @@ export interface operations { readonly "repos/get-repo-rule-suites": { readonly parameters: { readonly query?: { - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ readonly ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -109372,7 +110923,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -115159,6 +116711,30 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "users/get-by-id": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description account_id parameter */ + readonly account_id: components["parameters"]["account-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "users/list": { readonly parameters: { readonly query?: { @@ -115211,6 +116787,60 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "users/list-attestations": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + }; + readonly header?: never; + readonly path: { + /** @description The handle for the GitHub user account. */ + readonly username: components["parameters"]["username"]; + /** @description Subject Digest */ + readonly subject_digest: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly attestations?: readonly { + readonly bundle?: components["schemas"]["sigstore-bundle-0"]; + readonly repository_id?: number; + }[]; + }; + }; + }; + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "packages/list-docker-migration-conflicting-packages-for-user": { readonly parameters: { readonly query?: never; diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index e3f783031..dda08fda8 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -410,7 +410,8 @@ export interface paths { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; put?: never; @@ -610,10 +611,15 @@ export interface paths { }; /** * List all Copilot seat assignments for an enterprise - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -636,7 +642,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -720,7 +727,8 @@ export interface paths { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; put?: never; @@ -752,7 +760,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; put?: never; @@ -780,7 +789,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; delete?: never; @@ -1120,10 +1130,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1365,7 +1373,8 @@ export interface paths { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; put?: never; @@ -1383,7 +1392,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; put?: never; post?: never; @@ -1510,7 +1523,8 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; put?: never; @@ -1536,17 +1550,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -1569,20 +1572,13 @@ export interface paths { head?: never; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -2356,6 +2352,30 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/blocks": { parameters: { query?: never; @@ -2428,6 +2448,205 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + put?: never; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/detach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + put?: never; + post?: never; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + options?: never; + head?: never; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/codespaces": { parameters: { query?: never; @@ -2656,7 +2875,8 @@ export interface paths { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -2684,7 +2904,8 @@ export interface paths { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. * Only organization owners can view assigned seats. @@ -2711,7 +2932,8 @@ export interface paths { put?: never; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2722,12 +2944,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2757,7 +2982,8 @@ export interface paths { put?: never; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2768,12 +2994,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2801,7 +3030,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3021,7 +3251,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; put?: never; post?: never; @@ -3422,10 +3656,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -3562,7 +3794,8 @@ export interface paths { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * @@ -3734,35 +3967,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/organization-fine-grained-permissions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - get: operations["orgs/list-organization-fine-grained-permissions"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/organization-roles": { parameters: { query?: never; @@ -3772,7 +3976,7 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3783,18 +3987,7 @@ export interface paths { */ get: operations["orgs/list-org-roles"]; put?: never; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - post: operations["orgs/create-custom-organization-role"]; + post?: never; delete?: never; options?: never; head?: never; @@ -3813,7 +4006,7 @@ export interface paths { post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3835,7 +4028,7 @@ export interface paths { get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3845,7 +4038,7 @@ export interface paths { post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3869,7 +4062,7 @@ export interface paths { post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3891,7 +4084,7 @@ export interface paths { get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3901,7 +4094,7 @@ export interface paths { post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3922,7 +4115,7 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3934,33 +4127,10 @@ export interface paths { get: operations["orgs/get-org-role"]; put?: never; post?: never; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - delete: operations["orgs/delete-custom-organization-role"]; + delete?: never; options?: never; head?: never; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - patch: operations["orgs/patch-custom-organization-role"]; + patch?: never; trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/teams": { @@ -3972,7 +4142,7 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3996,7 +4166,7 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -4544,7 +4714,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; put?: never; @@ -4868,7 +5039,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; put?: never; @@ -4879,7 +5051,8 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; options?: never; @@ -4888,7 +5061,8 @@ export interface paths { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; trace?: never; @@ -4904,7 +5078,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4916,7 +5091,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4938,7 +5114,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4949,7 +5126,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4960,7 +5138,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4978,7 +5157,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4990,7 +5170,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5012,7 +5193,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5023,7 +5205,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5034,7 +5217,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5052,7 +5236,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5064,7 +5249,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5087,7 +5273,8 @@ export interface paths { post?: never; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -5110,7 +5297,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5122,7 +5310,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5145,7 +5334,8 @@ export interface paths { post?: never; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -5168,7 +5358,8 @@ export interface paths { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; put?: never; @@ -5214,10 +5405,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -5228,13 +5420,15 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; post?: never; @@ -5244,9 +5438,11 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; options?: never; @@ -5265,7 +5461,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; put?: never; @@ -5287,14 +5484,16 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; post?: never; @@ -5302,7 +5501,8 @@ export interface paths { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; options?: never; @@ -5321,7 +5521,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; put?: never; @@ -5349,14 +5550,16 @@ export interface paths { * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -5366,7 +5569,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; options?: never; @@ -5385,7 +5589,8 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; put?: never; @@ -5407,7 +5612,11 @@ export interface paths { put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * @@ -5650,7 +5859,8 @@ export interface paths { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -5663,7 +5873,8 @@ export interface paths { * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -5685,7 +5896,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; put?: never; @@ -6605,8 +6817,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -7193,6 +7405,54 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/attestations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/autolinks": { parameters: { query?: never; @@ -7327,9 +7587,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; post?: never; @@ -7402,7 +7664,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; trace?: never; @@ -7420,7 +7683,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; put?: never; @@ -7518,7 +7782,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; put?: never; @@ -7680,7 +7945,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -7710,7 +7976,8 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ post: operations["checks/create"]; delete?: never; @@ -7730,7 +7997,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7744,7 +8012,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7810,7 +8079,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7853,7 +8123,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7877,7 +8148,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -8007,8 +8279,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8660,7 +8932,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -8800,7 +9073,8 @@ export interface paths { post?: never; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -8952,7 +9226,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -9009,7 +9284,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -9035,7 +9311,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -9236,7 +9513,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -9252,7 +9530,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; options?: never; @@ -9680,7 +9959,8 @@ export interface paths { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -9691,9 +9971,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -9818,7 +10100,9 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -10039,8 +10323,8 @@ export interface paths { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - * + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; put?: never; @@ -10065,9 +10349,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; delete?: never; @@ -10233,7 +10519,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -10257,7 +10544,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; put?: never; @@ -10445,8 +10733,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; put?: never; @@ -10628,7 +10916,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; delete?: never; @@ -10649,7 +10938,8 @@ export interface paths { * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -10692,8 +10982,8 @@ export interface paths { * Importing into a GitHub repository with GitHub Actions enabled is not supported and will * return a status `422 Unprocessable Entity` response. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -10702,8 +10992,8 @@ export interface paths { * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -10718,7 +11008,8 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -10737,7 +11028,8 @@ export interface paths { * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -10767,8 +11059,8 @@ export interface paths { * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -10785,8 +11077,8 @@ export interface paths { * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -10819,8 +11111,8 @@ export interface paths { * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -10924,10 +11216,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11066,7 +11356,8 @@ export interface paths { post?: never; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -11132,10 +11423,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11391,7 +11680,8 @@ export interface paths { post?: never; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ @@ -12134,7 +12424,8 @@ export interface paths { post?: never; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -12337,8 +12628,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12438,7 +12729,8 @@ export interface paths { * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -12544,9 +12836,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12786,9 +13077,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; put?: never; @@ -12882,7 +13172,8 @@ export interface paths { post?: never; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -13217,7 +13508,8 @@ export interface paths { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; delete?: never; @@ -13259,12 +13551,10 @@ export interface paths { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; put?: never; @@ -13312,7 +13602,8 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; put?: never; @@ -13470,8 +13761,8 @@ export interface paths { /** * Deprecated - List tag protection states for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13482,8 +13773,8 @@ export interface paths { /** * Deprecated - Create a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13508,8 +13799,8 @@ export interface paths { /** * Deprecated - Delete a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13532,7 +13823,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; put?: never; @@ -13728,7 +14021,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; put?: never; @@ -13871,7 +14165,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; put?: never; @@ -14006,7 +14301,8 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14014,7 +14310,8 @@ export interface paths { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14026,11 +14323,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; trace?: never; @@ -14045,7 +14344,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14056,7 +14356,8 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14081,7 +14382,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14093,7 +14395,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14105,7 +14408,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14124,7 +14428,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14135,7 +14440,8 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14160,7 +14466,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14172,7 +14479,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14184,7 +14492,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14203,7 +14512,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14214,7 +14524,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14239,7 +14550,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14250,7 +14562,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14275,7 +14588,8 @@ export interface paths { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14298,7 +14612,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14339,7 +14654,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -14356,7 +14672,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; options?: never; @@ -14374,7 +14691,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14389,13 +14707,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -14406,13 +14726,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; options?: never; @@ -14430,7 +14752,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14453,7 +14776,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14461,7 +14785,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14470,7 +14795,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14490,7 +14816,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14511,9 +14838,11 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ @@ -14521,7 +14850,8 @@ export interface paths { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14532,7 +14862,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -14552,7 +14883,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -15304,10 +15636,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -16071,6 +16401,30 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -16117,6 +16471,30 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/docker/conflicts": { parameters: { query?: never; @@ -16149,6 +16527,9 @@ export interface paths { /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; put?: never; @@ -16169,6 +16550,9 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; put?: never; @@ -16186,7 +16570,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; put?: never; post?: never; @@ -16570,7 +16958,11 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; put?: never; @@ -16588,7 +16980,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; put?: never; post?: never; @@ -16948,7 +17344,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description A check run was completed, and a conclusion is available. */ post: operations["check-run/completed"]; @@ -16976,7 +17373,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description A new check run was created. */ post: operations["check-run/created"]; @@ -17004,7 +17402,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)." */ post: operations["check-run/requested-action"]; @@ -17032,7 +17431,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. */ post: operations["check-run/rerequested"]; @@ -17060,7 +17460,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description All check runs in a check suite have completed, and a conclusion is available. */ post: operations["check-suite/completed"]; @@ -17088,7 +17489,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)" in the REST API documentation. */ post: operations["check-suite/requested"]; @@ -17116,7 +17518,8 @@ export interface webhooks { * * Repository and organization webhooks only receive payloads for the `completed` event types in repositories. * - * **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * @description Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" in the REST API documentation. */ post: operations["check-suite/rerequested"]; @@ -17415,7 +17818,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * - * **Note**: This event will not occur when more than three tags are deleted at once. */ + * > [!NOTE] + * > This event will not occur when more than three tags are deleted at once. */ post: operations["delete"]; delete?: never; options?: never; @@ -17439,7 +17843,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A Dependabot alert was automatically closed by a Dependabot auto-triage rule. */ post: operations["dependabot-alert/auto-dismissed"]; @@ -17465,7 +17870,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. */ post: operations["dependabot-alert/auto-reopened"]; @@ -17491,7 +17897,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. */ post: operations["dependabot-alert/created"]; @@ -17517,7 +17924,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A Dependabot alert was manually closed. */ post: operations["dependabot-alert/dismissed"]; @@ -17543,7 +17951,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A manifest file change removed a vulnerability. */ post: operations["dependabot-alert/fixed"]; @@ -17569,7 +17978,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A manifest file change introduced a vulnerable dependency that had previously been fixed. */ post: operations["dependabot-alert/reintroduced"]; @@ -17595,7 +18005,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * - * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for Dependabot alerts are currently in beta and subject to change. * @description A Dependabot alert was manually reopened. */ post: operations["dependabot-alert/reopened"]; @@ -17807,7 +18218,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A comment on the discussion was marked as the answer. */ post: operations["discussion/answered"]; @@ -17833,7 +18245,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description The category of a discussion was changed. */ post: operations["discussion/category-changed"]; @@ -17859,7 +18272,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was closed. */ post: operations["discussion/closed"]; @@ -17885,7 +18299,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A comment on a discussion was created. */ post: operations["discussion-comment/created"]; @@ -17911,7 +18326,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A comment on a discussion was deleted. */ post: operations["discussion-comment/deleted"]; @@ -17937,7 +18353,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A comment on a discussion was edited. */ post: operations["discussion-comment/edited"]; @@ -17963,7 +18380,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was created. */ post: operations["discussion/created"]; @@ -17989,7 +18407,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was deleted. */ post: operations["discussion/deleted"]; @@ -18015,7 +18434,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description The title or body on a discussion was edited, or the category of the discussion was changed. */ post: operations["discussion/edited"]; @@ -18041,7 +18461,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A label was added to a discussion. */ post: operations["discussion/labeled"]; @@ -18067,7 +18488,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was locked. */ post: operations["discussion/locked"]; @@ -18093,7 +18515,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was pinned. */ post: operations["discussion/pinned"]; @@ -18119,7 +18542,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was reopened. */ post: operations["discussion/reopened"]; @@ -18145,7 +18569,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was transferred to another repository. */ post: operations["discussion/transferred"]; @@ -18171,7 +18596,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A comment on the discussion was unmarked as the answer. */ post: operations["discussion/unanswered"]; @@ -18197,7 +18623,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A label was removed from a discussion. */ post: operations["discussion/unlabeled"]; @@ -18223,7 +18650,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was unlocked. */ post: operations["discussion/unlocked"]; @@ -18249,7 +18677,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. * - * **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + * > [!NOTE] + * > Webhook events for GitHub Discussions are currently in beta and subject to change. * @description A discussion was unpinned. */ post: operations["discussion/unpinned"]; @@ -19668,7 +20097,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > [!NOTE] + * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was approved. */ post: operations["personal-access-token-request/approved"]; @@ -19692,7 +20122,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > [!NOTE] + * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was cancelled by the requester. */ post: operations["personal-access-token-request/cancelled"]; @@ -19716,7 +20147,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > [!NOTE] + * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was created. */ post: operations["personal-access-token-request/created"]; @@ -19740,7 +20172,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * > [!NOTE] + * > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. * @description A fine-grained personal access token request was denied. */ post: operations["personal-access-token-request/denied"]; @@ -20147,7 +20580,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was closed. */ post: operations["projects-v2/closed"]; @@ -20173,7 +20607,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was created. */ post: operations["projects-v2/created"]; @@ -20199,7 +20634,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was deleted. */ post: operations["projects-v2/deleted"]; @@ -20225,7 +20661,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description The title, description, or README of a project in the organization was changed. */ post: operations["projects-v2/edited"]; @@ -20251,7 +20688,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description An item on an organization project was archived. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." */ post: operations["projects-v2-item/archived"]; @@ -20277,7 +20715,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A draft issue in an organization project was converted to an issue. */ post: operations["projects-v2-item/converted"]; @@ -20303,7 +20742,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description An item was added to a project in the organization. */ post: operations["projects-v2-item/created"]; @@ -20329,7 +20769,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description An item was deleted from a project in the organization. */ post: operations["projects-v2-item/deleted"]; @@ -20355,7 +20796,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue. */ post: operations["projects-v2-item/edited"]; @@ -20381,7 +20823,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout. */ post: operations["projects-v2-item/reordered"]; @@ -20407,7 +20850,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description An archived item on an organization project was restored from the archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." */ post: operations["projects-v2-item/restored"]; @@ -20433,7 +20877,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. * - * **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * > [!NOTE] + * > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). * @description A project in the organization was reopened. */ post: operations["projects-v2/reopened"]; @@ -20443,6 +20888,87 @@ export interface webhooks { patch?: never; trace?: never; }; + "projects-v2-status-update-created": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + * + * For activity relating to a project, use the `projects_v2` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + * + * > [!NOTE] + * > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * @description A status update was added to a project in the organization. + */ + post: operations["projects-v2-status-update/created"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "projects-v2-status-update-deleted": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + * + * For activity relating to a project, use the `projects_v2` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + * + * > [!NOTE] + * > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * @description A status update was removed from a project in the organization. + */ + post: operations["projects-v2-status-update/deleted"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "projects-v2-status-update-edited": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + * + * For activity relating to a project, use the `projects_v2` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + * + * > [!NOTE] + * > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + * @description A status update was edited on a project in the organization. + */ + post: operations["projects-v2-status-update/edited"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; public: { parameters: { query?: never; @@ -21173,7 +21699,8 @@ export interface webhooks { * * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. * - * **Note**: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. */ + * > [!NOTE] + * > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. */ post: operations["push"]; delete?: never; options?: never; @@ -21195,7 +21722,8 @@ export interface webhooks { * * To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. * - * **Note**: GitHub recommends that you use the newer `package` event instead. + * > [!NOTE] + * > GitHub recommends that you use the newer `package` event instead. * @description A package was published to a registry. */ post: operations["registry-package/published"]; @@ -21219,7 +21747,8 @@ export interface webhooks { * * To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. * - * **Note**: GitHub recommends that you use the newer `package` event instead. + * > [!NOTE] + * > GitHub recommends that you use the newer `package` event instead. * @description A package that was previously published to a registry was updated. */ post: operations["registry-package/updated"]; @@ -21745,7 +22274,8 @@ export interface webhooks { /** * This event occurs when there is activity relating to a security vulnerability alert in a repository. * - * **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + * > [!WARNING] + * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. * @description A repository vulnerability alert was created. */ post: operations["repository-vulnerability-alert/create"]; @@ -21767,7 +22297,8 @@ export interface webhooks { /** * This event occurs when there is activity relating to a security vulnerability alert in a repository. * - * **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + * > [!WARNING] + * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. * @description A repository vulnerability alert was dismissed. */ post: operations["repository-vulnerability-alert/dismiss"]; @@ -21789,7 +22320,8 @@ export interface webhooks { /** * This event occurs when there is activity relating to a security vulnerability alert in a repository. * - * **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + * > [!WARNING] + * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. * @description A previously dismissed or resolved repository vulnerability alert was reopened. */ post: operations["repository-vulnerability-alert/reopen"]; @@ -21811,7 +22343,8 @@ export interface webhooks { /** * This event occurs when there is activity relating to a security vulnerability alert in a repository. * - * **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + * > [!WARNING] + * > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. * @description A repository vulnerability alert was marked as resolved. */ post: operations["repository-vulnerability-alert/resolve"]; @@ -22677,6 +23210,7 @@ export interface components { name?: string | null; email?: string | null; login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -22856,7 +23390,8 @@ export interface components { metadata?: string; contents?: string; deployments?: string; - [key: string]: string | undefined; + } & { + [key: string]: string; }; /** @description The list of events for the GitHub app */ events: string[]; @@ -23357,7 +23892,10 @@ export interface components { * @description A repository on GitHub. */ repository: { - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; node_id: string; /** @description The name of the repository. */ @@ -23622,6 +24160,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -24030,6 +24569,7 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { + /** Format: int64 */ id: number; name: string; slug: string; @@ -24108,7 +24648,7 @@ export interface components { /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: { + breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language?: string; /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ @@ -24123,8 +24663,9 @@ export interface components { lines_accepted?: number; /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ active_users?: number; + } & { [key: string]: unknown; - }[] | null; + })[] | null; }; /** @description The security alert number. */ "alert-number": number; @@ -24256,7 +24797,10 @@ export interface components { * @description A GitHub repository. */ "simple-repository": { - /** @description A unique identifier of the repository. */ + /** + * Format: int64 + * @description A unique identifier of the repository. + */ id: number; /** @description The GraphQL identifier of the repository. */ node_id: string; @@ -24766,7 +25310,7 @@ export interface components { language?: string; raw_url?: string; size?: number; - } | undefined; + }; }; public: boolean; /** Format: date-time */ @@ -24789,6 +25333,7 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -24908,7 +25453,7 @@ export interface components { language?: string; raw_url?: string; size?: number; - } | undefined; + }; }; public: boolean; /** Format: date-time */ @@ -24934,7 +25479,7 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: ({ + [key: string]: { filename?: string; type?: string; language?: string; @@ -24942,7 +25487,7 @@ export interface components { size?: number; truncated?: boolean; content?: string; - } | null) | undefined; + } | null; }; public?: boolean; created_at?: string; @@ -25122,12 +25667,17 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { + /** Format: int64 */ id: number; node_id: string; name: string; @@ -25348,34 +25898,59 @@ export interface components { members_can_create_private_pages?: boolean; members_can_fork_private_repositories?: boolean | null; web_commit_signoff_required?: boolean; - /** @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. */ + * This field is only visible to organization owners or members of a team with the security manager role. + */ advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. */ + * This field is only visible to organization owners or members of a team with the security manager role. + */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. */ + * This field is only visible to organization owners or members of a team with the security manager role. + */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. */ + * This field is only visible to organization owners or members of a team with the security manager role. + */ dependency_graph_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. */ + * This field is only visible to organization owners or members of a team with the security manager role. + */ secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. */ + * This field is only visible to organization owners or members of a team with the security manager role. + */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -25445,7 +26020,8 @@ export interface components { verified_allowed?: boolean; /** @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. */ + * > [!NOTE] + * > The `patterns_allowed` setting only applies to public repositories. */ patterns_allowed?: string[]; }; /** @@ -25619,7 +26195,7 @@ export interface components { * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -25627,8 +26203,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -25641,6 +26215,8 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -25705,6 +26281,102 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + target_type?: "global" | "organization"; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -25733,6 +26405,7 @@ export interface components { * @description A codespace. */ codespace: { + /** Format: int64 */ id: number; /** @description Automatically generated name of this codespace. */ name: string; @@ -25929,6 +26602,7 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + } & { [key: string]: unknown; }; /** @@ -25989,6 +26663,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -26087,6 +26762,7 @@ export interface components { * @description A migration. */ migration: { + /** Format: int64 */ id: number; owner: null | components["schemas"]["simple-user"]; guid: string; @@ -26112,20 +26788,15 @@ export interface components { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - "organization-fine-grained-permission": { - name: string; - description: string; - }; /** * Organization Role * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; @@ -26263,13 +26934,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ @@ -26299,13 +26970,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -26417,6 +27088,7 @@ export interface components { * @description Full Repository */ "full-repository": { + /** Format: int64 */ id: number; node_id: string; name: string; @@ -26659,6 +27331,11 @@ export interface components { name: string; /** @description The values to match for the repository property */ property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -26714,6 +27391,36 @@ export interface components { /** @enum {string} */ type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -26772,6 +27479,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -26923,6 +27632,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -26961,7 +27672,7 @@ export interface components { * Repository Rule * @description A repository rule. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { /** @enum {string} */ type: "file_path_restriction"; parameters?: { @@ -27002,7 +27713,8 @@ export interface components { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -27751,7 +28463,10 @@ export interface components { "project-card": { /** Format: uri */ url: string; - /** @description The project card's ID */ + /** + * Format: int64 + * @description The project card's ID + */ id: number; node_id: string; note: string | null; @@ -28025,6 +28740,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -28032,6 +28748,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -28041,6 +28758,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -28214,7 +28932,10 @@ export interface components { */ "pending-deployment": { environment: { - /** @description The id of the environment. */ + /** + * Format: int64 + * @description The id of the environment. + */ id?: number; node_id?: string; /** @description The name of the environment. */ @@ -28244,7 +28965,10 @@ export interface components { deployment: { /** Format: uri */ url: string; - /** @description Unique identifier of the deployment */ + /** + * Format: int64 + * @description Unique identifier of the deployment + */ id: number; node_id: string; sha: string; @@ -28468,6 +29192,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -28669,8 +29394,8 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: null | components["schemas"]["simple-user"]; - committer: null | components["schemas"]["simple-user"]; + author: (null | Record) & (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]); + committer: (null | Record) & (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]); parents: { sha: string; /** Format: uri */ @@ -29311,6 +30036,7 @@ export interface components { */ collaborator: { login: string; + /** Format: int64 */ id: number; email?: string | null; name?: string | null; @@ -29352,7 +30078,10 @@ export interface components { * @description Repository invitations let you manage who you collaborate with. */ "repository-invitation": { - /** @description Unique identifier of the repository invitation. */ + /** + * Format: int64 + * @description Unique identifier of the repository invitation. + */ id: number; repository: components["schemas"]["minimal-repository"]; invitee: null | components["schemas"]["simple-user"]; @@ -29446,6 +30175,7 @@ export interface components { "pull-request-simple": { /** Format: uri */ url: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -30009,6 +30739,8 @@ export interface components { licenseDeclared?: string; /** @description The distribution source of this package, or NOASSERTION if this was not determined. */ supplier?: string; + /** @description The copyright holders of the package, and any dates present with those notices, if available. */ + copyrightText?: string; externalRefs?: { /** @description The category of reference to an external resource this reference refers to. */ referenceCategory: string; @@ -30025,7 +30757,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: ((null | (string | number | boolean) | (number | string | boolean) | (boolean | string | number)) | string | number | boolean) | undefined; + [key: string]: (null | (string | number | boolean) | (number | string | boolean) | (boolean | string | number)) | string | number | boolean; }; dependency: { /** @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. */ @@ -30054,7 +30786,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"] | undefined; + [key: string]: components["schemas"]["dependency"]; }; }; /** @@ -30088,7 +30820,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"] | undefined; + [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time @@ -30103,6 +30835,7 @@ export interface components { "deployment-status": { /** Format: uri */ url: string; + /** Format: int64 */ id: number; node_id: string; /** @@ -30163,7 +30896,10 @@ export interface components { * @description Details of a deployment environment */ environment: { - /** @description The id of the environment. */ + /** + * Format: int64 + * @description The id of the environment. + */ id: number; node_id: string; /** @description The name of the environment. */ @@ -30900,7 +31636,10 @@ export interface components { * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). */ label: { - /** Format: int64 */ + /** + * Format: int64 + * @description Unique identifier for the label. + */ id: number; node_id: string; /** @@ -30910,9 +31649,11 @@ export interface components { url: string; /** @description The name of the label. */ name: string; + /** @description Optional description of the label, such as its purpose. */ description: string | null; /** @description 6-character hex code, without the leading #, identifying the color */ color: string; + /** @description Whether this label comes by default in a new repository. */ default: boolean; }; /** @@ -31063,9 +31804,15 @@ export interface components { "pull-request-review-comment": { /** @description URL for the pull request review comment */ url: string; - /** @description The ID of the pull request review to which the comment belongs. */ + /** + * Format: int64 + * @description The ID of the pull request review to which the comment belongs. + */ pull_request_review_id: number | null; - /** @description The ID of the pull request review comment. */ + /** + * Format: int64 + * @description The ID of the pull request review comment. + */ id: number; /** @description The node ID of the pull request review comment. */ node_id: string; @@ -31236,7 +31983,7 @@ export interface components { * @description Language */ language: { - [key: string]: number | undefined; + [key: string]: number; }; /** * License Content @@ -31474,6 +32221,7 @@ export interface components { "pull-request": { /** Format: uri */ url: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -31694,6 +32442,7 @@ export interface components { gravatar_id: string | null; /** Format: uri */ html_url: string; + /** Format: int64 */ id: number; node_id: string; login: string; @@ -31869,6 +32618,7 @@ export interface components { gravatar_id: string | null; /** Format: uri */ html_url: string; + /** Format: int64 */ id: number; node_id: string; login: string; @@ -31937,7 +32687,10 @@ export interface components { * @description Pull Request Reviews are reviews on pull requests. */ "pull-request-review": { - /** @description Unique identifier of the review */ + /** + * Format: int64 + * @description Unique identifier of the review + */ id: number; node_id: string; user: null | components["schemas"]["simple-user"]; @@ -31971,7 +32724,9 @@ export interface components { "review-comment": { /** Format: uri */ url: string; + /** Format: int64 */ pull_request_review_id: number | null; + /** Format: int64 */ id: number; node_id: string; diff_hunk: string; @@ -32122,7 +32877,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -32901,6 +33656,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -32953,6 +33709,7 @@ export interface components { */ "private-user": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -33080,6 +33837,7 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { + /** Format: int64 */ id: number; /** @description Automatically generated name of this codespace. */ name: string; @@ -33199,6 +33957,7 @@ export interface components { * @description A unique encryption key */ "gpg-key": { + /** Format: int64 */ id: number; name?: string | null; primary_key_id: number | null; @@ -33209,6 +33968,7 @@ export interface components { verified?: boolean; }[]; subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -33244,6 +34004,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -33310,6 +34071,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType?: string; + verificationMaterial?: { + x509CertificateChain?: { + certificates?: { + rawBytes?: string; + }[]; + }; + tlogEntries?: { + logIndex?: string; + logId?: { + keyId?: string; + }; + kindVersion?: { + kind?: string; + version?: string; + }; + integratedTime?: string; + inclusionPromise?: { + signedEntryTimestamp?: string; + }; + inclusionProof?: string | null; + canonicalizedBody?: string; + }[]; + timestampVerificationData?: string | null; + }; + dsseEnvelope?: { + payload?: string; + payloadType?: string; + signatures?: { + sig?: string; + keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -33333,7 +34133,6 @@ export interface components { * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." - * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -33399,7 +34198,10 @@ export interface components { * when the event occurs from activity in a repository. */ "repository-webhooks": { - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; node_id: string; /** @description The name of the repository. */ @@ -33835,6 +34637,13 @@ export interface components { ignore_approvals_from_contributors: boolean; /** @enum {string} */ linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -34047,6 +34856,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34117,6 +34927,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34259,6 +35070,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34279,6 +35091,7 @@ export interface components { /** Format: uri */ url?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -34328,6 +35141,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34456,6 +35270,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34873,6 +35688,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35354,6 +36170,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35643,6 +36460,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35675,37 +36493,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @@ -35954,6 +36772,28 @@ export interface components { duration?: number | null; start_date?: string | null; }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** @enum {string|null} */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** Format: date */ + start_date?: string; + /** Format: date */ + target_date?: string; + /** @description Body of the status update */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -36303,7 +37143,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -36485,6 +37328,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36643,7 +37487,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -36825,6 +37672,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37161,6 +38009,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37306,6 +38155,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37378,6 +38228,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38101,6 +38952,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -39648,6 +40513,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39701,7 +40567,7 @@ export interface components { definition: components["schemas"]["org-custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property deleted event */ @@ -39714,7 +40580,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property updated event */ @@ -39724,7 +40590,7 @@ export interface components { definition: components["schemas"]["org-custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** Custom property values updated event */ @@ -42377,7 +43243,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -42872,6 +43741,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43281,6 +44151,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43401,6 +44272,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -43811,6 +44683,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43931,6 +44804,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -44342,6 +45216,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44462,6 +45337,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -44889,6 +45765,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44956,6 +45833,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -45368,6 +46246,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45788,6 +46667,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46220,6 +47100,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46641,6 +47522,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47063,6 +47945,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47483,6 +48366,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47903,6 +48787,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48042,7 +48927,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48559,6 +49447,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48990,6 +49879,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49409,6 +50299,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49551,7 +50442,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50107,6 +51001,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50768,11 +51663,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; repo?: string; dependencies?: { - [key: string]: string | undefined; + [key: string]: string; }[]; commit_oid?: string; }; @@ -51877,6 +52772,57 @@ export interface components { projects_v2: components["schemas"]["projects-v2"]; sender: components["schemas"]["simple-user-webhooks"]; }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; + }; + status?: { + /** @enum {string|null} */ + from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** @enum {string|null} */ + to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + }; + start_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + target_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; /** public event */ "webhook-public": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -52192,7 +53138,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52374,6 +53323,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52532,7 +53482,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52714,6 +53667,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53050,6 +54004,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53380,7 +54335,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53562,6 +54520,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53720,7 +54679,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53902,6 +54864,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54238,6 +55201,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54569,7 +55533,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54751,6 +55718,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55091,6 +56059,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55427,6 +56396,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55794,7 +56764,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55976,6 +56949,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56134,7 +57108,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56316,6 +57293,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56652,6 +57630,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57014,7 +57993,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57196,6 +58178,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57354,7 +58337,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57536,6 +58522,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57872,6 +58859,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58203,7 +59191,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58385,6 +59376,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58543,7 +59535,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58725,6 +59720,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59061,6 +60057,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59391,7 +60388,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59573,6 +60573,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59731,7 +60732,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59913,6 +60917,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60249,6 +61254,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60449,6 +61455,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60769,7 +61776,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60951,6 +61961,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61102,7 +62113,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61284,6 +62298,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61569,6 +62584,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61897,7 +62913,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62079,6 +63098,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62230,7 +63250,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62412,6 +63435,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62697,6 +63721,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63026,7 +64051,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63208,6 +64236,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63359,7 +64388,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63541,6 +64573,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63826,6 +64859,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64154,7 +65188,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64336,6 +65373,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64487,7 +65525,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64669,6 +65710,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64954,6 +65996,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65028,6 +66071,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65356,7 +66400,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65497,6 +66544,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65643,7 +66691,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65784,6 +66835,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66069,6 +67121,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66401,7 +67454,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66576,6 +67632,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66734,7 +67791,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66916,6 +67976,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67252,6 +68313,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67618,7 +68680,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67800,6 +68865,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67958,7 +69024,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68140,6 +69209,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68476,6 +69546,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68862,7 +69933,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69044,6 +70118,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69202,7 +70277,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69384,6 +70462,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69720,6 +70799,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70086,7 +71166,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70268,6 +71351,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70426,7 +71510,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70608,6 +71695,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70944,6 +72032,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71327,7 +72416,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71509,6 +72601,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71660,7 +72753,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71842,6 +72938,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72127,6 +73224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72456,7 +73554,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72599,6 +73700,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72750,7 +73852,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72893,6 +73998,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73178,6 +74284,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73322,6 +74429,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73650,7 +74758,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73793,6 +74904,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73944,7 +75056,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74087,6 +75202,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74372,6 +75488,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74516,6 +75633,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74848,7 +75966,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75030,6 +76151,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75188,7 +76310,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75363,6 +76488,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75699,6 +76825,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76030,7 +77157,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76212,6 +77342,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76370,7 +77501,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76552,6 +77686,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76888,6 +78023,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77219,7 +78355,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -77401,6 +78540,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77559,7 +78699,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -77734,6 +78877,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78070,6 +79214,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78400,7 +79545,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78582,6 +79730,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78740,7 +79889,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78922,6 +80074,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -79258,6 +80411,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -79538,7 +80692,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -80501,6 +81658,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -81253,7 +82411,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81502,7 +82663,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81751,7 +82915,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -82031,7 +83198,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -82280,7 +83450,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -84239,15 +85412,15 @@ export interface components { }; }; }; - /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - package_es_list_error: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ + package_es_list_error: { headers: { [name: string]: unknown; }; @@ -84448,6 +85621,8 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -84489,6 +85664,9 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; /** @description The time period to filter by. @@ -84625,8 +85803,6 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - "ref-in-query": string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -84828,13 +86004,14 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["integration"] & { + "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; webhook_secret: string | null; pem: string; + } & { [key: string]: unknown; - }; + }); }; }; 404: components["responses"]["not_found"]; @@ -85543,7 +86720,7 @@ export interface operations { }; content: { "application/json": { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -85575,7 +86752,7 @@ export interface operations { }; content: { "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ + /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ total_seats?: number; seats?: components["schemas"]["copilot-seat-details"][]; }; @@ -85829,7 +87006,7 @@ export interface operations { [key: string]: { /** @description Content of the file */ content: string; - } | undefined; + }; }; public?: boolean | ("true" | "false"); }; @@ -85986,12 +87163,12 @@ export interface operations { * To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be * deleted if the specified object does not contain at least one of `content` or `filename`. */ files?: { - [key: string]: ({ + [key: string]: { /** @description The new content of the file. */ content?: string; /** @description The new filename for the file. */ filename?: string | null; - } | null) | undefined; + } | null; }; } | null; }; @@ -87278,41 +88455,71 @@ export interface operations { */ web_commit_signoff_required?: boolean; blog?: string; - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot security updates is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** @description Whether dependency graph is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependency_graph_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -88569,141 +89776,22 @@ export interface operations { }; }; }; - "orgs/list-blocked-users": { + "orgs/list-attestations": { parameters: { query?: { /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "orgs/check-blocked-user": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description If the user is blocked */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description If the user is not blocked */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; - }; - }; - "orgs/block-user": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/unblock-user": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "code-scanning/list-alerts-for-org": { - parameters: { - query?: { - /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; - /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: components["parameters"]["per-page"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description If specified, only code scanning alerts with this state will be returned. */ - state?: components["schemas"]["code-scanning-alert-state-query"]; - /** @description The property by which to sort the results. */ - sort?: "created" | "updated"; - /** @description If specified, only code scanning alerts with this severity will be returned. */ - severity?: components["schemas"]["code-scanning-alert-severity"]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; }; cookie?: never; }; @@ -88712,18 +89800,613 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; + "application/json": { + attestations?: { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + }[]; + }; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/list-in-organization": { + "orgs/list-blocked-users": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "orgs/check-blocked-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description If the user is blocked */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description If the user is not blocked */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "orgs/block-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/unblock-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-scanning/list-alerts-for-org": { + parameters: { + query?: { + /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name?: components["parameters"]["tool-name"]; + /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description If specified, only code scanning alerts with this state will be returned. */ + state?: components["schemas"]["code-scanning-alert-state-query"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated"; + /** @description If specified, only code scanning alerts with this severity will be returned. */ + severity?: components["schemas"]["code-scanning-alert-severity"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + "code-security/get-default-configurations": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/detach-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/get-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/delete-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-security/attach-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "public" | "private_or_internal" | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + "code-security/set-configuration-as-default": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "codespaces/list-in-organization": { parameters: { query?: { /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -91091,31 +92774,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/list-organization-fine-grained-permissions": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/list-org-roles": { parameters: { query?: never; @@ -91146,43 +92804,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "orgs/create-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/revoke-all-org-roles-team": { parameters: { query?: never; @@ -91384,68 +93005,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "orgs/delete-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "orgs/patch-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/list-org-role-teams": { parameters: { query?: { @@ -92819,7 +94378,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -92849,6 +94409,9 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. @@ -92964,7 +94527,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -93147,13 +94711,6 @@ export interface operations { }; content?: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; }; }; "orgs/remove-security-manager-team": { @@ -94421,10 +95978,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -95404,6 +96958,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -97819,6 +99378,101 @@ export interface operations { }; }; }; + "repos/create-attestation": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The ID of the attestation. */ + id?: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + }[]; + }; + }; + }; + }; + }; "repos/list-autolinks": { parameters: { query?: never; @@ -97954,7 +99608,7 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { headers: { [name: string]: unknown; @@ -97963,7 +99617,7 @@ export interface operations { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { headers: { [name: string]: unknown; @@ -99352,15 +101006,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } & ({ + } & (({ /** @enum {unknown} */ status: "completed"; + } & { [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ status?: "queued" | "in_progress"; + } & { [key: string]: unknown; - }); + })); }; }; responses: { @@ -99497,15 +101153,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } | { + } | ({ /** @enum {unknown} */ status?: "completed"; + } & { [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ status?: "queued" | "in_progress"; + } & { [key: string]: unknown; - }; + }); }; }; responses: { @@ -102526,7 +104184,10 @@ export interface operations { */ state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -103619,7 +105280,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -103996,8 +105657,7 @@ export interface operations { content?: string; }[]; /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - * */ + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ base_tree?: string; }; }; @@ -109389,7 +111049,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -109419,7 +111080,8 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -109545,7 +111207,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -115249,6 +116912,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/get-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description account_id parameter */ + account_id: components["parameters"]["account-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; "users/list": { parameters: { query?: { @@ -115301,6 +116988,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { + bundle?: components["schemas"]["sigstore-bundle-0"]; + repository_id?: number; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { query?: never; @@ -121822,6 +123563,117 @@ export interface operations { }; }; }; + "projects-v2-status-update/created": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example project-v2-status-update */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-projects-v2-status-update-created"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "projects-v2-status-update/deleted": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example project-v2-status-update */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-projects-v2-status-update-deleted"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "projects-v2-status-update/edited": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example project-v2-status-update */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-projects-v2-status-update-edited"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; public: { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index c868b1182..5ce9cafb1 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -1110,9 +1110,9 @@ paths: "/apps/{app_slug}": get: summary: Get an app - description: "**Note**: The `:app_slug` is just the URL-friendly name of your - GitHub App. You can find this on the settings page for your GitHub App (e.g., - `https://github.com/settings/apps/:app_slug`)." + description: |- + > [!NOTE] + > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). tags: - apps operationId: apps/get-by-slug @@ -1426,10 +1426,15 @@ paths: get: summary: List all Copilot seat assignments for an enterprise description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + + For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -1459,8 +1464,9 @@ paths: properties: total_seats: type: integer - description: Total number of Copilot seats for the organization - currently being billed. + description: The total number of Copilot seats the enterprise + is being billed for. Users with access through multiple organizations + or enterprise teams are only counted once. seats: type: array items: @@ -1488,7 +1494,8 @@ paths: get: summary: Get a summary of Copilot usage for enterprise members description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -1670,9 +1677,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -1721,7 +1728,8 @@ paths: By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + > [!NOTE] + > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity operationId: activity/get-feeds @@ -1788,7 +1796,8 @@ paths: description: |- Allows you to add a new gist with one or more files. - **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + > [!NOTE] + > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. operationId: gists/create tags: - gists @@ -2760,10 +2769,8 @@ paths: repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -3333,7 +3340,8 @@ paths: The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. - **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + > [!NOTE] + > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. tags: - meta operationId: meta/get @@ -3361,7 +3369,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -3746,7 +3756,8 @@ paths: description: |- Lists all organizations, in the order that they were created. - **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + > [!NOTE] + > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: - orgs operationId: orgs/list @@ -3790,17 +3801,6 @@ paths: To see the full details about an organization, the authenticated user must be an organization owner. - The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - - - advanced_security_enabled_for_new_repositories - - dependabot_alerts_enabled_for_new_repositories - - dependabot_security_updates_enabled_for_new_repositories - - dependency_graph_enabled_for_new_repositories - - secret_scanning_enabled_for_new_repositories - - secret_scanning_push_protection_enabled_for_new_repositories - - For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -3832,20 +3832,13 @@ paths: patch: summary: Update an organization description: |- - **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + > [!WARNING] + > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - Updates the organization's profile and member privileges. - - With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - - - advanced_security_enabled_for_new_repositories - - dependabot_alerts_enabled_for_new_repositories - - dependabot_security_updates_enabled_for_new_repositories - - dependency_graph_enabled_for_new_repositories - - secret_scanning_enabled_for_new_repositories - - secret_scanning_push_protection_enabled_for_new_repositories + > [!WARNING] + > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). - For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + Updates the organization's profile and member privileges. The authenticated user must be an organization owner to use this endpoint. @@ -3980,51 +3973,69 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - Whether GitHub Advanced Security is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - Whether Dependabot alerts is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - Whether Dependabot security updates is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean description: |- - Whether dependency graph is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean description: |- - Whether secret scanning is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - Whether secret scanning push protection is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true secret_scanning_push_protection_custom_link_enabled: type: boolean description: Whether a custom link is shown to contributors who @@ -5867,6 +5878,73 @@ paths: enabledForGitHubApps: true category: actions subcategory: variables + "/orgs/{org}/attestations/{subject_digest}": + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-attestations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + examples: + default: + "$ref": "#/components/examples/list-attestations" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/blocks": get: summary: List users blocked by an organization @@ -6042,6 +6120,697 @@ paths: enabledForGitHubApps: true category: code-scanning subcategory: code-scanning + "/orgs/{org}/code-security/configurations": + get: + summary: Get code security configurations for an organization + description: |- + Lists all code security configurations available in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: target_type + in: query + description: The target type of the code security configuration + required: false + schema: + type: string + enum: + - global + - all + default: all + - name: per_page + in: query + description: The number of results per page (max 100). For more information, + see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + required: false + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration-list" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + post: + summary: Create a code security configuration + description: |- + Creates a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + default: disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/defaults": + get: + summary: Get default code security configurations + description: |- + Lists the default code security configurations for an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-default-configurations" + examples: + default: + "$ref": "#/components/examples/code-security-default-configurations" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/detach": + delete: + summary: Detach configurations from repositories + description: |- + Detach code security configuration(s) from a set of repositories. + Repositories will retain their settings but will no longer be associated with the configuration. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/detach-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + selected_repository_ids: + type: array + description: An array of repository IDs to detach from configurations. + items: + type: integer + description: Unique identifier of the repository. + examples: + default: + summary: Example for detaching repositories from configurations. + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + "$ref": "#/components/responses/no_content" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}": + get: + summary: Get a code security configuration + description: |- + Gets a code security configuration available in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + patch: + summary: Update a code security configuration + description: |- + Updates a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/update-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-org recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled + responses: + '200': + description: Response when a configuration is updated + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration-updated" + '204': + description: Response when no new updates are made + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + delete: + summary: Delete a code security configuration + description: |- + Deletes the desired code security configuration from an organization. + Repositories attached to the configuration will retain their settings but will no longer be associated with + the configuration. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + responses: + '204': + "$ref": "#/components/responses/no_content" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": + post: + summary: Attach a configuration to repositories + description: |- + Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + + If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration + to. `selected` means the configuration will be attached to only + the repositories specified by `selected_repository_ids` + enum: + - all + - public + - private_or_internal + - selected + selected_repository_ids: + type: array + description: An array of repository IDs to attach the configuration + to. You can only provide a list of repository ids when the `scope` + is set to `selected`. + items: + type: integer + description: Unique identifier of the repository. + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: selected + selected_repository_ids: + - 32 + - 91 + responses: + '202': + "$ref": "#/components/responses/accepted" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": + put: + summary: Set a code security configuration as a default for an organization + description: |- + Sets a code security configuration as a default to be applied to new repositories in your organization. + + This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specify which types of repository this security configuration + should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: Set this configuration to be enabled by default on all new + repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specifies which types of repository this security + configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + value: + default_for_new_repos: all + configuration: + "$ref": "#/components/examples/code-security-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": + get: + summary: Get repositories associated with a code security configuration + description: |- + Lists the repositories associated with a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-repositories-for-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + - name: per_page + description: The number of results per page (max 100). For more information, + see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: status + description: |- + A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + + Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + in: query + required: false + schema: + type: string + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-security-configuration-repositories" + examples: + default: + summary: Example of code security configuration repositories + value: + - status: attached + repository: + "$ref": "#/components/examples/simple-repository" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations "/orgs/{org}/codespaces": get: summary: List codespaces for the organization @@ -6672,7 +7441,8 @@ paths: get: summary: Get Copilot seat information and settings for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -6718,7 +7488,8 @@ paths: get: summary: List all Copilot seat assignments for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. Only organization owners can view assigned seats. @@ -6779,7 +7550,8 @@ paths: post: summary: Add teams to the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -6790,6 +7562,8 @@ paths: For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + The response will contain the total number of new seats that were created and existing seats that were refreshed. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -6860,7 +7634,8 @@ paths: delete: summary: Remove teams from the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Cancels the Copilot seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -6942,7 +7717,8 @@ paths: post: summary: Add users to the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -6953,6 +7729,8 @@ paths: For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + The response will contain the total number of new seats that were created and existing seats that were refreshed. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -7023,7 +7801,8 @@ paths: delete: summary: Remove users from the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Cancels the Copilot seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -7106,7 +7885,8 @@ paths: get: summary: Get a summary of Copilot usage for organization members description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -7643,7 +8423,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -8630,10 +9412,8 @@ paths: description: |- List issues in an organization assigned to the authenticated user. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -8967,7 +9747,8 @@ paths: get: summary: Get Copilot seat assignment details for a user description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. @@ -9452,54 +10233,11 @@ paths: enabledForGitHubApps: false category: migrations subcategory: orgs - "/orgs/{org}/organization-fine-grained-permissions": - get: - summary: List organization fine-grained permissions for an organization - description: |- - Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-organization-fine-grained-permissions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/organization-fine-grained-permission" - examples: - default: - "$ref": "#/components/examples/organization-fine-grained-permission-example" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles "/orgs/{org}/organization-roles": get: summary: Get all organization roles for an organization description: |- - Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: @@ -9544,106 +10282,11 @@ paths: enabledForGitHubApps: true category: orgs subcategory: organization-roles - post: - summary: Create a custom organization role - description: |- - Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/create-custom-organization-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the custom role. - description: - type: string - description: A short description about the intended usage of this - role or what permissions it grants. - permissions: - type: array - description: A list of additional permissions included in this role. - items: - type: string - required: - - name - - permissions - examples: - default: - value: - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/organization-role" - examples: - default: - value: - id: 8030 - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:19:11Z' - '422': - "$ref": "#/components/responses/validation_failed" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles "/orgs/{org}/organization-roles/teams/{team_slug}": delete: summary: Remove all organization roles for a team description: |- - Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9669,7 +10312,7 @@ paths: put: summary: Assign an organization role to a team description: |- - Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9700,7 +10343,7 @@ paths: delete: summary: Remove an organization role from a team description: |- - Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9727,7 +10370,7 @@ paths: delete: summary: Remove all organization roles for a user description: |- - Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9753,7 +10396,7 @@ paths: put: summary: Assign an organization role to a user description: |- - Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9785,7 +10428,7 @@ paths: delete: summary: Remove an organization role from a user description: |- - Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9812,7 +10455,7 @@ paths: get: summary: Get an organization role description: |- - Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: @@ -9848,127 +10491,11 @@ paths: enabledForGitHubApps: true category: orgs subcategory: organization-roles - patch: - summary: Update a custom organization role - description: |- - Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/patch-custom-organization-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/role-id" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the custom role. - description: - type: string - description: A short description about the intended usage of this - role or what permissions it grants. - permissions: - type: array - description: A list of additional permissions included in this role. - items: - type: string - examples: - default: - value: - description: Permissions to manage custom roles within an org. - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/organization-role" - examples: - default: - value: - id: 8030 - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:19:11Z' - '422': - "$ref": "#/components/responses/validation_failed" - '409': - "$ref": "#/components/responses/conflict" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - delete: - summary: Delete a custom organization role. - description: |- - Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/delete-custom-organization-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/role-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles "/orgs/{org}/organization-roles/{role_id}/teams": get: summary: List teams that are assigned to an organization role description: |- - Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -10014,7 +10541,7 @@ paths: get: summary: List users that are assigned to an organization role description: |- - Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -11597,7 +12124,8 @@ paths: description: |- Lists repositories for the specified organization. - **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > [!NOTE] + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/list-for-org @@ -11941,7 +12469,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -12020,6 +12549,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/ref-in-query" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/actor-name-in-query" @@ -12154,7 +12684,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -12426,9 +12957,6 @@ paths: responses: '204': description: Response - '409': - description: The organization has reached the maximum number of security - manager teams. x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12699,7 +13227,8 @@ paths: description: |- Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/get-by-name @@ -12731,7 +13260,8 @@ paths: description: |- To edit a team, the authenticated user must either be an organization owner or a team maintainer. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/update-in-org @@ -12835,7 +13365,8 @@ paths: If you are an organization owner, deleting a parent team will delete all of its child teams as well. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/delete-in-org @@ -12859,7 +13390,8 @@ paths: description: |- List all discussions on a team's page. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -12907,7 +13439,8 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -12969,7 +13502,8 @@ paths: description: |- Get a specific discussion on a team's page. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13002,7 +13536,8 @@ paths: description: |- Edits the title and body text of a discussion post. Only the parameters you provide are updated. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13052,7 +13587,8 @@ paths: description: |- Delete a discussion from a team's page. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13079,7 +13615,8 @@ paths: description: |- List all comments on a team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13122,7 +13659,8 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13173,7 +13711,8 @@ paths: description: |- Get a specific comment on a team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13207,7 +13746,8 @@ paths: description: |- Edits the body text of a discussion comment. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13257,7 +13797,8 @@ paths: description: |- Deletes a comment on a team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13285,7 +13826,8 @@ paths: description: |- List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13344,7 +13886,8 @@ paths: A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13413,7 +13956,8 @@ paths: delete: summary: Delete team discussion comment reaction description: |- - **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -13444,7 +13988,8 @@ paths: description: |- List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13502,7 +14047,8 @@ paths: A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13569,7 +14115,8 @@ paths: delete: summary: Delete team discussion reaction description: |- - **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -13599,7 +14146,8 @@ paths: description: |- The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. tags: - teams operationId: teams/list-pending-invitations-in-org @@ -13688,10 +14236,11 @@ paths: To get a user's membership with a team, the team must be visible to the authenticated user. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - **Note:** - The response contains the `state` of the membership and the member's `role`. + > [!NOTE] + > The response contains the `state` of the membership and the member's `role`. The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). tags: @@ -13728,13 +14277,15 @@ paths: Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. tags: - teams operationId: teams/add-or-update-membership-for-user-in-org @@ -13791,9 +14342,11 @@ paths: Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. tags: - teams operationId: teams/remove-membership-for-user-in-org @@ -13820,7 +14373,8 @@ paths: description: |- Lists the organization projects for a team. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. tags: - teams operationId: teams/list-projects-in-org @@ -13858,7 +14412,8 @@ paths: description: |- Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. tags: - teams operationId: teams/check-permissions-for-project-in-org @@ -13891,7 +14446,8 @@ paths: description: |- Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. tags: - teams operationId: teams/add-or-update-project-permissions-in-org @@ -13957,7 +14513,8 @@ paths: description: |- Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. tags: - teams operationId: teams/remove-project-in-org @@ -13982,7 +14539,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: - teams operationId: teams/list-repos-in-org @@ -14026,7 +14584,8 @@ paths: If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams operationId: teams/check-permissions-for-repo-in-org @@ -14064,7 +14623,8 @@ paths: description: |- To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". tags: @@ -14094,7 +14654,6 @@ paths: If no permission is specified, the team''s `permission` attribute will be used to determine what permission to grant the team on this repository.' - default: push examples: default: summary: Adding a team to an organization repository with the write @@ -14114,7 +14673,8 @@ paths: description: |- If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams operationId: teams/remove-repo-in-org @@ -14140,7 +14700,8 @@ paths: description: |- Lists the child teams of the team specified by `{team_slug}`. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. tags: - teams operationId: teams/list-child-in-org @@ -14176,6 +14737,9 @@ paths: post: summary: Enable or disable a security feature for an organization description: |- + > [!WARNING] + > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -14220,6 +14784,9 @@ paths: previews: [] category: orgs subcategory: orgs + deprecationDate: '2024-07-22' + removalDate: '2025-07-22' + deprecated: true "/projects/columns/cards/{card_id}": get: summary: Get a project card @@ -15257,7 +15824,8 @@ paths: get: summary: Get rate limit status for the authenticated user description: |- - **Note:** Accessing this endpoint does not count against your REST API rate limit. + > [!NOTE] + > Accessing this endpoint does not count against your REST API rate limit. Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -15270,7 +15838,8 @@ paths: * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." - **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + > [!NOTE] + > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit operationId: rate-limit/get @@ -15310,7 +15879,8 @@ paths: description: |- The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. - **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > [!NOTE] + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/get @@ -15427,6 +15997,15 @@ paths: status: type: string description: Can be `enabled` or `disabled`. + secret_scanning_non_provider_patterns: + type: object + description: Use the `status` property to enable or disable + secret scanning non-provider patterns for this repository. + For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. has_issues: type: boolean description: Either `true` to enable issues for this repository @@ -17394,8 +17973,8 @@ paths: description: |- Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - **Note:** GitHub Apps can only review their own custom deployment protection rules. - To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + > [!NOTE] + > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -18685,6 +19264,146 @@ paths: enabledForGitHubApps: true category: issues subcategory: assignees + "/repos/{owner}/{repo}/attestations": + post: + summary: Create an attestation + description: |- + Store an artifact attestation and associate it with a repository. + + The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/create-attestation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#create-an-attestation + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + required: + - bundle + examples: + default: + summary: Example of a request body + value: + "$ref": "#/components/examples/attestation" + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: integer + description: The ID of the attestation. + examples: + default: + value: + id: 2 + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + "/repos/{owner}/{repo}/attestations/{subject_digest}": + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with a repository. + + The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-attestations + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + examples: + default: + "$ref": "#/components/examples/list-attestations" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos "/repos/{owner}/{repo}/autolinks": get: summary: Get all autolinks of a repository @@ -18863,7 +19582,7 @@ paths: - "$ref": "#/components/parameters/repo" responses: '200': - description: Response if dependabot is enabled + description: Response if Dependabot is enabled content: application/json: schema: @@ -18874,7 +19593,7 @@ paths: enabled: true paused: false '404': - description: Not Found if dependabot is not enabled for the repository + description: Not Found if Dependabot is not enabled for the repository x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19044,9 +19763,11 @@ paths: Protecting a branch requires admin or owner permissions to the repository. - **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + > [!NOTE] + > Passing new arrays of `users` and `teams` replaces their previous values. - **Note**: The list of users, apps, and teams in total is limited to 100 items. + > [!NOTE] + > The list of users, apps, and teams in total is limited to 100 items. tags: - repos operationId: repos/update-branch-protection @@ -19481,7 +20202,8 @@ paths: Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + > [!NOTE] + > Passing new arrays of `users` and `teams` replaces their previous values. tags: - repos operationId: repos/update-pull-request-review-protection @@ -19636,7 +20358,8 @@ paths: When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. - **Note**: You must enable branch protection to require signed commits. + > [!NOTE] + > You must enable branch protection to require signed commits. tags: - repos operationId: repos/get-commit-signature-protection @@ -20116,7 +20839,8 @@ paths: Lists who has access to this protected branch. - **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + > [!NOTE] + > Users, apps, and teams `restrictions` are only available for organization-owned repositories. tags: - repos operationId: repos/get-access-restrictions @@ -20864,7 +21588,8 @@ paths: description: |- Renames a branch in a repository. - **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + > [!NOTE] + > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. @@ -20926,7 +21651,8 @@ paths: In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. tags: - checks operationId: checks/create @@ -21230,7 +21956,8 @@ paths: description: |- Gets a single check run using its `id`. - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -21263,7 +21990,8 @@ paths: description: |- Updates a check run for a specific commit in a repository. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: @@ -21619,7 +22347,8 @@ paths: description: |- Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: @@ -21739,7 +22468,8 @@ paths: description: |- Gets a single check suite using its `id`. - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -21773,7 +22503,8 @@ paths: description: |- Lists check runs for a check suite using its `id`. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -22092,8 +22823,8 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - **Deprecation notice**: - The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + > [!WARNING] + > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/list-recent-analyses @@ -23791,7 +24522,8 @@ paths: - If the user had their own fork of the repository, the fork will be deleted. - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + > [!NOTE] + > A user can still have access to the repository through organization permissions like base repository permissions. Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. @@ -24140,7 +24872,8 @@ paths: delete: summary: Delete a commit comment reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). tags: @@ -24485,7 +25218,8 @@ paths: description: |- Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + > [!NOTE] + > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. @@ -24564,7 +25298,8 @@ paths: description: |- Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. @@ -24633,7 +25368,8 @@ paths: description: |- Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -24999,7 +25735,8 @@ paths: description: |- Creates a new file or replaces an existing file in a repository. - **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > [!NOTE] + > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: @@ -25141,7 +25878,8 @@ paths: You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > [!NOTE] + > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file @@ -26185,11 +26923,11 @@ paths: - success target_url: type: string - description: The target URL to associate with this status. This - URL should contain output to keep the user updated while the task - is running or serve as historical information for what happened - in the deployment. **Note:** It's recommended to use the `log_url` - parameter, which replaces `target_url`. + description: |- + The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + + > [!NOTE] + > It's recommended to use the `log_url` parameter, which replaces `target_url`. default: '' log_url: type: string @@ -26400,7 +27138,8 @@ paths: get: summary: Get an environment description: |- - **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + > [!NOTE] + > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." Anyone with read access to the repository can use this endpoint. @@ -26435,9 +27174,11 @@ paths: description: |- Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." - **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + > [!NOTE] + > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + > [!NOTE] + > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -26876,7 +27617,9 @@ paths: get: summary: List custom deployment rule integrations available for an environment description: |- - Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + Gets all custom deployment protection rule integrations that are available for an environment. + + The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." @@ -27406,8 +28149,9 @@ paths: "/repos/{owner}/{repo}/events": get: summary: List repository events - description: "**Note**: This API is not built to serve real-time use cases. - Depending on the time of day, event latency can be anywhere from 30s to 6h.\n" + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-repo-events @@ -27490,9 +28234,11 @@ paths: description: |- Create a fork for the authenticated user. - **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + > [!NOTE] + > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + > [!NOTE] + > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. tags: - repos operationId: repos/create-fork @@ -27722,10 +28468,11 @@ paths: description: The SHA of the tree object this commit points to parents: type: array - description: The SHAs of the commits that were the parents of this - commit. If omitted or empty, the commit will be written as a root - commit. For a single parent, an array of one SHA should be provided; - for a merge commit, an array of more than one should be provided. + description: The full SHAs of the commits that were the parents + of this commit. If omitted or empty, the commit will be written + as a root commit. For a single parent, an array of one SHA should + be provided; for a merge commit, an array of more than one should + be provided. items: type: string author: @@ -27908,7 +28655,8 @@ paths: When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. tags: @@ -27949,7 +28697,8 @@ paths: description: |- Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". tags: - git operationId: git/get-ref @@ -28389,7 +29138,7 @@ paths: Using both `tree.sha` and `content` will return an error." base_tree: type: string - description: | + description: |- The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. required: @@ -28439,8 +29188,8 @@ paths: If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - - **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + > [!NOTE] + > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. tags: - git operationId: git/get-tree @@ -28969,7 +29718,8 @@ paths: description: |- This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + > [!NOTE] + > Previously `/repos/:owner/:repo/hooks/:hook_id/test` tags: - repos operationId: repos/test-push-webhook @@ -28996,7 +29746,8 @@ paths: description: |- View the progress of an import. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** @@ -29063,12 +29814,13 @@ paths: deprecated: true put: summary: Start an import - description: | + description: |- Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import @@ -29159,7 +29911,8 @@ paths: have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import @@ -29241,10 +29994,11 @@ paths: deprecated: true delete: summary: Cancel an import - description: | + description: |- Stop an import for a repository. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import @@ -29275,7 +30029,8 @@ paths: This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors @@ -29313,11 +30068,12 @@ paths: "/repos/{owner}/{repo}/import/authors/{author_id}": patch: summary: Map a commit author - description: | + description: |- Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author @@ -29378,10 +30134,11 @@ paths: "/repos/{owner}/{repo}/import/large_files": get: summary: Get large files - description: | + description: |- List files larger than 100MB found during the import - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files @@ -29416,14 +30173,15 @@ paths: "/repos/{owner}/{repo}/import/lfs": patch: summary: Update Git LFS preference - description: | + description: |- You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/repositories/working-with-files/managing-large-files). - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference @@ -29732,10 +30490,8 @@ paths: description: |- List issues in a repository. Only open issues will be listed. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -30264,7 +31020,8 @@ paths: delete: summary: Delete an issue comment reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). tags: @@ -30373,10 +31130,8 @@ paths: access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -31363,7 +32118,8 @@ paths: delete: summary: Delete an issue reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). tags: @@ -33757,7 +34513,8 @@ paths: delete: summary: Delete a pull request comment reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: @@ -34351,8 +35108,8 @@ paths: description: |- Lists the files in a specified pull request. - **Note:** Responses include a maximum of 3000 files. The paginated response - returns 30 files per page by default. + > [!NOTE] + > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -34736,7 +35493,8 @@ paths: Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + > [!NOTE] + > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. @@ -35050,9 +35808,8 @@ paths: description: |- Dismisses a specified review on a pull request. - **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - you must be a repository administrator or be included in the list of people or teams - who can dismiss pull request reviews. + > [!NOTE] + > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -35754,9 +36511,8 @@ paths: description: |- Gets a public release with the specified release ID. - **Note:** This returns an `upload_url` key corresponding to the endpoint - for uploading release assets. This key is a hypermedia resource. For more information, see - "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + > [!NOTE] + > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release @@ -36135,7 +36891,8 @@ paths: delete: summary: Delete a release reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). tags: @@ -36271,7 +37028,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -36489,7 +37247,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -37186,7 +37945,8 @@ paths: description: |- Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. - **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + > [!NOTE] + > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. tags: - security-advisories operationId: security-advisories/create-fork @@ -37271,12 +38031,11 @@ paths: "/repos/{owner}/{repo}/stats/code_frequency": get: summary: Get the weekly commit activity - description: |2 - + description: |- Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - 10,000 or more commits, a 422 status code will be returned. + > [!NOTE] + > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. tags: - repos operationId: repos/get-code-frequency-stats @@ -37357,7 +38116,8 @@ paths: * `d` - Number of deletions * `c` - Number of commits - **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + > [!NOTE] + > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. tags: - repos operationId: repos/get-contributors-stats @@ -37730,8 +38490,8 @@ paths: get: summary: Deprecated - List tag protection states for a repository description: |- - **Note**: This operation is deprecated and will be removed after August 30th 2024 - Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + > [!WARNING] + > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. This returns the tag protection states of a repository. @@ -37772,8 +38532,8 @@ paths: post: summary: Deprecated - Create a tag protection state for a repository description: |- - **Note**: This operation is deprecated and will be removed after August 30th 2024 - Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + > [!WARNING] + > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. This creates a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -37829,8 +38589,8 @@ paths: delete: summary: Deprecated - Delete a tag protection state for a repository description: |- - **Note**: This operation is deprecated and will be removed after August 30th 2024 - Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + > [!WARNING] + > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. This deletes a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -37866,7 +38626,9 @@ paths: Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. - **Note**: For private repositories, these links are temporary and expire after five minutes. + + > [!NOTE] + > For private repositories, these links are temporary and expire after five minutes. tags: - repos externalDocs: @@ -38295,7 +39057,8 @@ paths: `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. - **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + > [!NOTE] + > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. tags: - repos externalDocs: @@ -38408,7 +39171,7 @@ paths: type: string x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: repos subcategory: repos "/repositories": @@ -38646,7 +39409,8 @@ paths: This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!NOTE] + > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." tags: - search operationId: search/issues-and-pull-requests @@ -39035,10 +39799,9 @@ paths: "/teams/{team_id}": get: summary: Get a team (Legacy) - description: "**Deprecation Notice:** This endpoint route is deprecated and - will be removed from the Teams API. We recommend migrating your existing code - to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) - endpoint." + description: |- + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy @@ -39070,11 +39833,13 @@ paths: patch: summary: Update a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. - **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + > [!NOTE] + > With nested teams, the `privacy` for parent teams cannot be `secret`. tags: - teams operationId: teams/update-legacy @@ -39177,7 +39942,8 @@ paths: delete: summary: Delete a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -39209,7 +39975,8 @@ paths: get: summary: List discussions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. List all discussions on a team's page. @@ -39251,7 +40018,8 @@ paths: post: summary: Create a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. Creates a new discussion post on a team's page. @@ -39317,7 +40085,8 @@ paths: get: summary: Get a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. Get a specific discussion on a team's page. @@ -39352,7 +40121,8 @@ paths: patch: summary: Update a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. @@ -39404,7 +40174,8 @@ paths: delete: summary: Delete a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. Delete a discussion from a team's page. @@ -39433,7 +40204,8 @@ paths: get: summary: List discussion comments (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. List all comments on a team discussion. @@ -39476,7 +40248,8 @@ paths: post: summary: Create a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. Creates a new comment on a team discussion. @@ -39531,7 +40304,8 @@ paths: get: summary: Get a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. Get a specific comment on a team discussion. @@ -39567,7 +40341,8 @@ paths: patch: summary: Update a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. Edits the body text of a discussion comment. @@ -39619,7 +40394,8 @@ paths: delete: summary: Delete a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. Deletes a comment on a team discussion. @@ -39649,7 +40425,8 @@ paths: get: summary: List reactions for a team discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -39708,7 +40485,8 @@ paths: post: summary: Create reaction for a team discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -39773,7 +40551,8 @@ paths: get: summary: List reactions for a team discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -39831,7 +40610,8 @@ paths: post: summary: Create reaction for a team discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -39895,7 +40675,8 @@ paths: get: summary: List pending team invitations (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. tags: @@ -39935,7 +40716,8 @@ paths: get: summary: List team members (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: @@ -40026,7 +40808,8 @@ paths: To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: @@ -40068,7 +40851,8 @@ paths: To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-member-legacy @@ -40095,7 +40879,8 @@ paths: get: summary: Get team membership for a user (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. @@ -40137,13 +40922,15 @@ paths: put: summary: Add or update team membership for a user (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. @@ -40204,13 +40991,15 @@ paths: delete: summary: Remove team membership for a user (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-membership-for-user-legacy @@ -40237,7 +41026,8 @@ paths: get: summary: List team projects (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. Lists the organization projects for a team. tags: @@ -40279,7 +41069,8 @@ paths: get: summary: Check team permissions for a project (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. tags: @@ -40314,7 +41105,8 @@ paths: put: summary: Add or update team project permissions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. tags: @@ -40384,7 +41176,8 @@ paths: delete: summary: Remove a project from a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. tags: @@ -40414,10 +41207,9 @@ paths: "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) - description: "**Deprecation Notice:** This endpoint route is deprecated and - will be removed from the Teams API. We recommend migrating your existing code - to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) - endpoint." + description: |- + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy @@ -40457,9 +41249,11 @@ paths: get: summary: Check team permissions for a repository (Legacy) description: |- - **Note**: Repositories inherited through a parent team will also be checked. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + > [!NOTE] + > Repositories inherited through a parent team will also be checked. You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: tags: @@ -40497,7 +41291,8 @@ paths: put: summary: Add or update team repository permissions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. @@ -40552,7 +41347,8 @@ paths: delete: summary: Remove a repository from a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -40579,10 +41375,9 @@ paths: "/teams/{team_id}/teams": get: summary: List child teams (Legacy) - description: "**Deprecation Notice:** This endpoint route is deprecated and - will be removed from the Teams API. We recommend migrating your existing code - to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) - endpoint." + description: |- + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy @@ -42776,10 +43571,8 @@ paths: description: |- List issues across owned and member repositories assigned to the authenticated user. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -45041,6 +45834,44 @@ paths: enabledForGitHubApps: false category: teams subcategory: teams + "/user/{account_id}": + get: + summary: Get a user using their ID + description: |- + Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-a-user-using-their-id + parameters: + - "$ref": "#/components/parameters/account-id" + responses: + '200': + description: Response + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/private-user" + - "$ref": "#/components/schemas/public-user" + examples: + default-response: + "$ref": "#/components/examples/public-user-default-response" + response-with-git-hub-plan-information: + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users "/users": get: summary: List users @@ -45119,6 +45950,71 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/users/{username}/attestations/{subject_digest}": + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/username" + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + "$ref": "#/components/schemas/sigstore-bundle-0" + repository_id: + type: integer + examples: + default: + value: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -45158,8 +46054,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -45190,8 +46089,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -45223,7 +46125,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -45935,9 +46839,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -45968,7 +46875,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user @@ -46705,7 +47614,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A check run was completed, and a conclusion is available. operationId: check-run/completed externalDocs: @@ -46785,7 +47695,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A new check run was created. operationId: check-run/created externalDocs: @@ -46865,7 +47776,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, @@ -46948,7 +47860,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. operationId: check-run/rerequested @@ -47029,7 +47942,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: All check runs in a check suite have completed, and a conclusion is available. operationId: check-suite/completed @@ -47100,7 +48014,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) @@ -47174,7 +48089,8 @@ webhooks: Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) @@ -48025,7 +48941,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - **Note**: This event will not occur when more than three tags are deleted at once. + > [!NOTE] + > This event will not occur when more than three tags are deleted at once. operationId: delete externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete @@ -48092,7 +49009,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed @@ -48161,7 +49079,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. @@ -48231,7 +49150,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. @@ -48301,7 +49221,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: @@ -48369,7 +49290,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: @@ -48437,7 +49359,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced @@ -48506,7 +49429,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: @@ -49088,7 +50012,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: @@ -49156,7 +50081,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: @@ -49224,7 +50150,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was closed. operationId: discussion/closed externalDocs: @@ -49292,7 +50219,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: @@ -49360,7 +50288,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: @@ -49428,7 +50357,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: @@ -49496,7 +50426,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was created. operationId: discussion/created externalDocs: @@ -49564,7 +50495,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was deleted. operationId: discussion/deleted externalDocs: @@ -49632,7 +50564,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: The title or body on a discussion was edited, or the category of the discussion was changed. operationId: discussion/edited @@ -49701,7 +50634,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A label was added to a discussion. operationId: discussion/labeled externalDocs: @@ -49769,7 +50703,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was locked. operationId: discussion/locked externalDocs: @@ -49837,7 +50772,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was pinned. operationId: discussion/pinned externalDocs: @@ -49905,7 +50841,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was reopened. operationId: discussion/reopened externalDocs: @@ -49973,7 +50910,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: @@ -50041,7 +50979,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: @@ -50109,7 +51048,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: @@ -50177,7 +51117,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: @@ -50245,7 +51186,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: @@ -54297,7 +55239,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: @@ -54361,7 +55304,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled @@ -54426,7 +55370,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: @@ -54490,7 +55435,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: @@ -55582,7 +56528,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: @@ -55649,7 +56596,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was created. operationId: projects-v2/created externalDocs: @@ -55716,7 +56664,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: @@ -55762,7 +56711,76 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: projects_v2 + supported-webhook-types: + - organization + projects-v2-edited: + post: + summary: |- + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The title, description, or README of a project in the organization + was changed. + operationId: projects-v2/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: project-v2 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55774,21 +56792,22 @@ webhooks: subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-edited: + projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The title, description, or README of a project in the organization - was changed. - operationId: projects-v2/edited + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An item on an organization project was archived. For more information, + see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -55802,7 +56821,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -55830,7 +56849,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55839,10 +56858,10 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-archived: + projects-v2-item-converted: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55851,10 +56870,10 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/archived + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A draft issue in an organization project was converted to an issue. + operationId: projects-v2-item/converted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55898,7 +56917,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55910,7 +56929,7 @@ webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-converted: + projects-v2-item-created: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55919,9 +56938,10 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A draft issue in an organization project was converted to an issue. - operationId: projects-v2-item/converted + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An item was added to a project in the organization. + operationId: projects-v2-item/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55965,7 +56985,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55977,7 +56997,7 @@ webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-created: + projects-v2-item-deleted: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55986,9 +57006,10 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was added to a project in the organization. - operationId: projects-v2-item/created + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An item was deleted from a project in the organization. + operationId: projects-v2-item/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -56032,7 +57053,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56044,7 +57065,7 @@ webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-deleted: + projects-v2-item-edited: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -56053,9 +57074,12 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was deleted from a project in the organization. - operationId: projects-v2-item/deleted + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The values or state of an item in an organization project were + changed. For example, the value of a field was updated, the body of a draft + issue was changed, or a draft issue was converted to an issue. + operationId: projects-v2-item/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -56099,7 +57123,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56111,7 +57135,7 @@ webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-edited: + projects-v2-item-reordered: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -56120,11 +57144,12 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The values or state of an item in an organization project were - changed. For example, the value of a field was updated, the body of a draft - issue was changed, or a draft issue was converted to an issue. - operationId: projects-v2-item/edited + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The position of an item in an organization project was changed. + For example, an item was moved above or below another item in the table or + board layout. + operationId: projects-v2-item/reordered externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -56168,7 +57193,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56180,7 +57205,7 @@ webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-reordered: + projects-v2-item-restored: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -56189,11 +57214,11 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The position of an item in an organization project was changed. - For example, an item was moved above or below another item in the table or - board layout. - operationId: projects-v2-item/reordered + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An archived item on an organization project was restored from the + archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/restored externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -56237,7 +57262,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56249,21 +57274,21 @@ webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-restored: + projects-v2-reopened: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/restored + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was reopened. + operationId: projects-v2/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -56277,7 +57302,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -56305,7 +57330,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56314,23 +57339,24 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-reopened: + projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was reopened. - operationId: projects-v2/reopened + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was added to a project in the organization. + operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -56344,7 +57370,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -56372,7 +57398,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56381,7 +57407,143 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_status_update + supported-webhook-types: + - organization + projects-v2-status-update-deleted: + post: + summary: |- + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + + For activity relating to a project, use the `projects_v2` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was removed from a project in the organization. + operationId: projects-v2-status-update/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: project-v2-status-update + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: projects_v2_status_update + supported-webhook-types: + - organization + projects-v2-status-update-edited: + post: + summary: |- + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + + For activity relating to a project, use the `projects_v2` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was edited on a project in the organization. + operationId: projects-v2-status-update/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: project-v2-status-update + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: projects_v2_status_update supported-webhook-types: - organization public: @@ -58384,7 +59546,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - **Note**: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. operationId: push externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#push @@ -58449,7 +59612,8 @@ webhooks: To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - **Note**: GitHub recommends that you use the newer `package` event instead. + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. description: A package was published to a registry. operationId: registry-package/published externalDocs: @@ -58515,7 +59679,8 @@ webhooks: To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - **Note**: GitHub recommends that you use the newer `package` event instead. + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: @@ -60069,7 +61234,8 @@ webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: @@ -60132,7 +61298,8 @@ webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: @@ -60195,7 +61362,8 @@ webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A previously dismissed or resolved repository vulnerability alert was reopened. operationId: repository-vulnerability-alert/reopen @@ -60259,7 +61427,8 @@ webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: @@ -62692,6 +63861,7 @@ components: - octocat id: type: integer + format: int64 examples: - 1 node_id: @@ -64104,6 +65274,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 examples: - 42 node_id: @@ -64735,6 +65906,7 @@ components: properties: id: type: integer + format: int64 url: type: string format: uri @@ -65771,6 +66943,7 @@ components: properties: id: type: integer + format: int64 name: type: string slug: @@ -66233,6 +67406,7 @@ components: properties: id: type: integer + format: int64 description: A unique identifier of the repository. examples: - 1296269 @@ -67461,6 +68635,7 @@ components: type: string id: type: integer + format: int64 node_id: type: string avatar_url: @@ -68389,6 +69564,14 @@ components: enum: - enabled - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled minimal-repository: title: Minimal Repository description: Minimal Repository @@ -68396,6 +69579,7 @@ components: properties: id: type: integer + format: int64 examples: - 1296269 node_id: @@ -69101,56 +70285,69 @@ components: advanced_security_enabled_for_new_repositories: type: boolean description: |- + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. examples: - false + deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - this organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. examples: - false + deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - to this organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. examples: - false + deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean description: |- - Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. examples: - false + deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean description: |- - Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. examples: - false + deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - Whether secret scanning push protection is automatically enabled for new repositories and repositories - transferred to this organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. examples: - false + deprecated: true secret_scanning_push_protection_custom_link_enabled: type: boolean description: Whether a custom link is shown to contributors who are blocked @@ -69313,7 +70510,8 @@ components: description: |- Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. - **Note**: The `patterns_allowed` setting only applies to public repositories. + > [!NOTE] + > The `patterns_allowed` setting only applies to public repositories. items: type: string actions-default-workflow-permissions: @@ -69634,10 +70832,10 @@ components: description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." enum: - - - false positive - won't fix - used in tests + - code-scanning-alert-dismissed-comment: type: - string @@ -69655,13 +70853,6 @@ components: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -69687,6 +70878,13 @@ components: description: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string code-scanning-analysis-tool-version: type: - string @@ -69828,6 +71026,143 @@ components: - tool - most_recent_instance - repository + code-security-configuration: + type: object + description: A code security configuration + properties: + id: + type: integer + description: The ID of the code security configuration + name: + type: string + description: The name of the code security configuration. Must be unique + within the organization. + target_type: + type: string + description: The type of the code security configuration. + enum: + - global + - organization + description: + type: string + description: A description of the code security configuration + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + url: + type: string + format: uri + description: The URL of the configuration + html_url: + type: string + format: uri + description: The URL of the configuration + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + code-security-default-configurations: + type: array + description: A list of default code security configurations + items: + type: object + properties: + default_for_new_repos: + enum: + - public + - private_and_internal + - all + description: The visibility of newly created repositories for which the + code security configuration will be applied to by default + configuration: + "$ref": "#/components/schemas/code-security-configuration" + code-security-configuration-repositories: + type: object + description: Repositories associated with a code security configuration and + attachment status + properties: + status: + type: string + description: The attachment status of the code security configuration on + the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + repository: + "$ref": "#/components/schemas/simple-repository" codespace-machine: type: object title: Codespace machine @@ -69896,6 +71231,7 @@ components: properties: id: type: integer + format: int64 examples: - 1 name: @@ -70425,6 +71761,7 @@ components: properties: id: type: integer + format: int64 login: type: - string @@ -70664,6 +72001,7 @@ components: properties: id: type: integer + format: int64 examples: - 79 owner: @@ -70746,18 +72084,6 @@ components: - url - created_at - updated_at - organization-fine-grained-permission: - title: Organization Fine-Grained Permission - description: A fine-grained permission that protects organization resources. - type: object - properties: - name: - type: string - description: - type: string - required: - - name - - description organization-role: title: Organization Role description: Organization roles @@ -70766,6 +72092,7 @@ components: id: description: The unique identifier of the role. type: integer + format: int64 name: description: The name of the role. type: string @@ -71466,6 +72793,7 @@ components: properties: id: type: integer + format: int64 examples: - 1296269 node_id: @@ -72135,6 +73463,13 @@ components: description: The values to match for the repository property items: type: string + source: + type: string + description: The source of the repository property. Defaults to 'custom' + if not specified. + enum: + - custom + - system required: - name - property_values @@ -72239,6 +73574,78 @@ components: type: string enum: - required_linear_history + repository-rule-merge-queue: + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check to report a conclusion. + After this much time has elapsed, checks that have not reported a + conclusion will be assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit created by merge + queue for each PR in the group must pass all required checks to merge. + When set to HEADGREEN, only the commit at the head of the merge group, + i.e. the commit containing changes from all of the PRs in the group, + must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests requesting checks + and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after the first PR is + added to the queue for the minimum group size to be met. After this + time has elapsed, the minimum group size will be ignored and a smaller + group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes repository-rule-required-deployments: title: required_deployments description: Choose which environments must be successfully deployed to before @@ -72346,6 +73753,10 @@ components: parameters: type: object properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. required_status_checks: type: array description: Status checks that are required. @@ -72588,6 +73999,10 @@ components: parameters: type: object properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. workflows: type: array description: Workflows that must pass for this rule to pass. @@ -72662,6 +74077,7 @@ components: - "$ref": "#/components/schemas/repository-rule-update" - "$ref": "#/components/schemas/repository-rule-deletion" - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-merge-queue" - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-required-signatures" - "$ref": "#/components/schemas/repository-rule-pull-request" @@ -72674,7 +74090,8 @@ components: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - title: file_path_restriction description: |- - Note: file_path_restriction is in beta and subject to change. + > [!NOTE] + > `file_path_restriction` is in beta and subject to change. Prevent commits that include changes in specified file paths from being pushed to the commit graph. type: object @@ -72698,7 +74115,8 @@ components: - restricted_file_paths - title: max_file_path_length description: |- - Note: max_file_path_length is in beta and subject to change. + > [!NOTE] + > `max_file_path_length` is in beta and subject to change. Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. type: object @@ -72721,7 +74139,8 @@ components: - max_file_path_length - title: file_extension_restriction description: |- - Note: file_extension_restriction is in beta and subject to change. + > [!NOTE] + > `file_extension_restriction` is in beta and subject to change. Prevent commits that include files with specified file extensions from being pushed to the commit graph. type: object @@ -72745,7 +74164,8 @@ components: - restricted_file_extensions - title: max_file_size description: |- - Note: max_file_size is in beta and subject to change. + > [!NOTE] + > `max_file_size` is in beta and subject to change. Prevent commits that exceed a specified file size limit from being pushed to the commit. type: object @@ -72790,7 +74210,8 @@ components: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -74633,6 +76054,7 @@ components: id: description: The project card's ID type: integer + format: int64 examples: - 42 node_id: @@ -75299,6 +76721,7 @@ components: properties: id: type: integer + format: int64 number: type: integer url: @@ -75315,6 +76738,7 @@ components: properties: id: type: integer + format: int64 url: type: string name: @@ -75339,6 +76763,7 @@ components: properties: id: type: integer + format: int64 url: type: string name: @@ -75754,6 +77179,7 @@ components: id: description: The id of the environment. type: integer + format: int64 examples: - 56780428 node_id: @@ -75825,6 +77251,7 @@ components: id: description: Unique identifier of the deployment type: integer + format: int64 examples: - 42 node_id: @@ -76361,6 +77788,7 @@ components: type: string id: type: integer + format: int64 node_id: type: string avatar_url: @@ -76841,13 +78269,19 @@ components: - tree - url author: - anyOf: - - type: 'null' + oneOf: - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object committer: - anyOf: - - type: 'null' + oneOf: - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object parents: type: array items: @@ -78408,6 +79842,7 @@ components: - octocat id: type: integer + format: int64 examples: - 1 email: @@ -78539,6 +79974,7 @@ components: id: description: Unique identifier of the repository invitation. type: integer + format: int64 examples: - 42 repository: @@ -78740,6 +80176,7 @@ components: - https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer + format: int64 examples: - 1 node_id: @@ -80219,6 +81656,12 @@ components: if this was not determined. examples: - NOASSERTION + copyrightText: + type: string + description: The copyright holders of the package, and any dates + present with those notices, if available. + examples: + - Copyright (c) 1985 GitHub.com externalRefs: type: array items: @@ -80459,6 +81902,7 @@ components: - https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: type: integer + format: int64 examples: - 1 node_id: @@ -80588,6 +82032,7 @@ components: id: description: The id of the environment. type: integer + format: int64 examples: - 56780428 node_id: @@ -82422,6 +83867,7 @@ components: type: object properties: id: + description: Unique identifier for the label. type: integer format: int64 examples: @@ -82442,6 +83888,7 @@ components: examples: - bug description: + description: Optional description of the label, such as its purpose. type: - string - 'null' @@ -82454,6 +83901,7 @@ components: examples: - FFFFFF default: + description: Whether this label comes by default in a new repository. type: boolean examples: - true @@ -82800,11 +84248,13 @@ components: type: - integer - 'null' + format: int64 examples: - 42 id: description: The ID of the pull request review comment. type: integer + format: int64 examples: - 1 node_id: @@ -83776,6 +85226,7 @@ components: - https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer + format: int64 examples: - 1 node_id: @@ -84368,6 +85819,7 @@ components: format: uri id: type: integer + format: int64 node_id: type: string login: @@ -84814,6 +86266,7 @@ components: format: uri id: type: integer + format: int64 node_id: type: string login: @@ -85034,6 +86487,7 @@ components: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -85126,10 +86580,12 @@ components: type: - integer - 'null' + format: int64 examples: - 42 id: type: integer + format: int64 examples: - 10 node_id: @@ -85492,6 +86948,9 @@ components: - allOf: - "$ref": "#/components/schemas/repository-rule-required-linear-history" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-merge-queue" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -87353,6 +88812,7 @@ components: type: string id: type: integer + format: int64 node_id: type: string avatar_url: @@ -87478,6 +88938,7 @@ components: - octocat id: type: integer + format: int64 examples: - 1 node_id: @@ -87837,6 +89298,7 @@ components: properties: id: type: integer + format: int64 examples: - 1 name: @@ -88110,6 +89572,7 @@ components: properties: id: type: integer + format: int64 examples: - 3 name: @@ -88149,6 +89612,7 @@ components: properties: id: type: integer + format: int64 primary_key_id: type: integer key_id: @@ -88254,6 +89718,7 @@ components: type: string id: type: integer + format: int64 url: type: string title: @@ -88402,6 +89867,78 @@ components: required: - starred_at - repo + sigstore-bundle-0: + title: Sigstore Bundle v0.1 + description: Sigstore Bundle v0.1 + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: + x509CertificateChain: + type: object + properties: + certificates: + type: array + items: + type: object + properties: + rawBytes: + type: string + tlogEntries: + type: array + items: + type: object + properties: + logIndex: + type: string + logId: + type: object + properties: + keyId: + type: string + kindVersion: + type: object + properties: + kind: + type: string + version: + type: string + integratedTime: + type: string + inclusionPromise: + type: object + properties: + signedEntryTimestamp: + type: string + inclusionProof: + type: + - string + - 'null' + canonicalizedBody: + type: string + timestampVerificationData: + type: + - string + - 'null' + dsseEnvelope: + type: object + properties: + payload: + type: string + payloadType: + type: string + signatures: + type: array + items: + type: object + properties: + sig: + type: string + keyid: + type: string hovercard: title: Hovercard description: Hovercard @@ -88435,7 +89972,7 @@ components: - id enterprise-webhooks: title: Enterprise - description: | + description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." @@ -88606,6 +90143,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 examples: - 42 node_id: @@ -89591,6 +91129,20 @@ components: - 'off' - non_admins - everyone + lock_branch_enforcement_level: + description: The enforcement level of the branch lock setting. `off` means + the branch is not locked, `non_admins` means the branch is read-only for + non_admins, and `everyone` means the branch is read-only for everyone. + type: string + enum: + - 'off' + - non_admins + - everyone + lock_allows_fork_sync: + description: Whether users can pull changes from upstream when the branch + is locked. Set to `true` to allow users to pull changes from upstream + when the branch is locked. This setting is only applicable for forks. + type: boolean merge_queue_enforcement_level: type: string enum: @@ -89665,6 +91217,7 @@ components: - strict_required_status_checks_policy - signature_requirement_enforcement_level - linear_history_requirement_enforcement_level + - lock_branch_enforcement_level - admin_enforced - allow_force_pushes_enforcement_level - allow_deletions_enforcement_level @@ -90166,6 +91719,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -90310,6 +91864,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -90612,6 +92167,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -90647,6 +92203,10 @@ components: required: - login - id + labels: + type: array + items: + "$ref": "#/components/schemas/label" required: - repository_url - category @@ -90776,6 +92336,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -91031,6 +92592,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -91952,6 +93514,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -93005,6 +94568,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -93637,6 +95201,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -94274,6 +95839,62 @@ components: required: - id - title + projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + status: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + start_date: + type: string + format: date + examples: + - '2022-04-28' + target_date: + type: string + format: date + examples: + - '2022-04-28' + body: + description: Body of the status update + type: + - string + - 'null' + examples: + - The project is off to a great start! + required: + - id + - node_id + - created_at + - updated_at webhooks_number: description: The pull request number. type: integer @@ -94849,6 +96470,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -95252,6 +96874,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -95482,6 +97105,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -95885,6 +97509,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -96555,6 +98180,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -96850,6 +98476,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -97012,6 +98639,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -98553,6 +100181,46 @@ components: - everyone required: - from + lock_branch_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + lock_allows_fork_sync: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + pull_request_reviews_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + require_last_push_approval: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from required_status_checks: type: object properties: @@ -102115,6 +103783,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -102240,7 +103909,6 @@ components: required: - action - definition - - organization webhook-custom-property-deleted: title: custom property deleted event type: object @@ -102268,7 +103936,6 @@ components: required: - action - definition - - organization webhook-custom-property-updated: title: custom property updated event type: object @@ -102290,7 +103957,6 @@ components: required: - action - definition - - organization webhook-custom-property-values-updated: title: Custom property values updated event type: object @@ -108199,6 +109865,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -109300,6 +110967,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -110217,6 +111885,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -110488,6 +112157,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -111400,6 +113070,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -111671,6 +113342,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -112588,6 +114260,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -112859,6 +114532,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -113803,6 +115477,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -113978,6 +115653,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -114879,6 +116555,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -115844,6 +117521,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -116783,6 +118461,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -117727,6 +119406,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -118696,6 +120376,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -119635,6 +121316,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -120549,6 +122231,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -120761,6 +122444,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -121943,6 +123627,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -122936,6 +124621,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -123846,6 +125532,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -124059,6 +125746,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -125349,6 +127037,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -129396,6 +131085,134 @@ components: - projects_v2 - organization - sender + webhook-projects-v2-status-update-created: + title: Projects v2 Status Update Created Event + type: object + properties: + action: + type: string + enum: + - created + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + projects_v2_status_update: + "$ref": "#/components/schemas/projects-v2-status-update" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - projects_v2_status_update + - organization + - sender + webhook-projects-v2-status-update-deleted: + title: Projects v2 Status Update Deleted Event + type: object + properties: + action: + type: string + enum: + - deleted + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + projects_v2_status_update: + "$ref": "#/components/schemas/projects-v2-status-update" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - projects_v2_status_update + - organization + - sender + webhook-projects-v2-status-update-edited: + title: Projects v2 Status Update Edited Event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + status: + type: object + properties: + from: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + to: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + start_date: + type: object + properties: + from: + type: + - string + - 'null' + format: date + to: + type: + - string + - 'null' + format: date + target_date: + type: object + properties: + from: + type: + - string + - 'null' + format: date + to: + type: + - string + - 'null' + format: date + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + projects_v2_status_update: + "$ref": "#/components/schemas/projects-v2-status-update" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - projects_v2_status_update + - organization + - sender webhook-public: title: public event type: object @@ -129941,6 +131758,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -130345,6 +132163,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -130579,6 +132398,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -130983,6 +132803,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -131664,6 +133485,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -132272,6 +134094,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -132676,6 +134499,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -132906,6 +134730,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -133310,6 +135135,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -133990,6 +135816,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -134600,6 +136427,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -135004,6 +136832,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -135638,6 +137467,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -136319,6 +138149,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -137011,6 +138842,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -137415,6 +139247,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -137645,6 +139478,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -138049,6 +139883,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -138720,6 +140555,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -139400,6 +141236,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -139804,6 +141641,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -140034,6 +141872,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -140438,6 +142277,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -141109,6 +142949,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -141720,6 +143561,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -142124,6 +143966,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -142358,6 +144201,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -142762,6 +144606,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -143444,6 +145289,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -144052,6 +145898,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -144456,6 +146303,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -144690,6 +146538,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -145094,6 +146943,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -145775,6 +147625,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -146205,6 +148056,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -146779,6 +148631,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -147183,6 +149036,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -147404,6 +149258,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -147807,6 +149662,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -148394,6 +150250,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -148996,6 +150853,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -149400,6 +151258,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -149621,6 +151480,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -150025,6 +151885,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -150601,6 +152462,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -151205,6 +153067,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -151609,6 +153472,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -151830,6 +153694,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -152234,6 +154099,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -152811,6 +154677,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -153415,6 +155282,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -153819,6 +155687,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -154040,6 +155909,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -154444,6 +156314,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -155030,6 +156901,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -155208,6 +157080,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -155794,6 +157667,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -156143,6 +158017,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -156360,6 +158235,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -156709,6 +158585,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -157296,6 +159173,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -157908,6 +159786,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -158303,6 +160182,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -158533,6 +160413,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -158937,6 +160818,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -159626,6 +161508,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -160301,6 +162184,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -160705,6 +162589,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -160935,6 +162820,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -161339,6 +163225,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -162028,6 +163915,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -162750,6 +164638,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -163154,6 +165043,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -163384,6 +165274,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -163788,6 +165679,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -164469,6 +166361,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -165148,6 +167041,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -165552,6 +167446,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -165782,6 +167677,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -166186,6 +168082,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -166858,6 +168755,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -167566,6 +169464,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -167970,6 +169869,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -168193,6 +170093,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -168597,6 +170498,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -169184,6 +171086,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -169789,6 +171692,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -170143,6 +172047,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -170366,6 +172271,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -170720,6 +172626,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -171306,6 +173213,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -171618,6 +173526,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -172208,6 +174117,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -172562,6 +174472,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -172781,6 +174692,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -173135,6 +175047,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -173711,6 +175624,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -174020,6 +175934,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -174621,6 +176536,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -175025,6 +176941,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -175255,6 +177172,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -175650,6 +177568,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -176331,6 +178250,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -176946,6 +178866,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -177350,6 +179271,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -177584,6 +179506,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -177988,6 +179911,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -178670,6 +180594,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -179280,6 +181205,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -179684,6 +181610,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -179918,6 +181845,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -180313,6 +182241,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -180994,6 +182923,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -181599,6 +183529,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -182003,6 +183934,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -182235,6 +184167,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -182639,6 +184572,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -183309,6 +185243,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -183795,6 +185730,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -186157,6 +188093,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -187731,6 +189668,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -188218,6 +190156,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -188706,6 +190645,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -189258,6 +191198,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -189747,6 +191688,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -199182,6 +201124,97 @@ components: updated_at: '2020-01-10T14:59:22Z' visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 simple-user-items: value: - login: octocat @@ -199430,6 +201463,192 @@ components: teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + code-security-configuration-list: + value: + - id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: organization + name: High risk settings + description: This is a code security configuration for octo-org high risk + repositories + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + code-security-configuration: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-default-configurations: + value: + - default_for_new_repos: public + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + - default_for_new_repos: private_and_internal + configuration: + id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + code-security-configuration-updated: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings v2 + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: disabled + secret_scanning_push_protection: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: disabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + simple-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks codespaces-list: value: total_count: 3 @@ -201076,12 +203295,8 @@ components: status: enabled secret_scanning_push_protection: status: disabled - organization-fine-grained-permission-example: - value: - - name: read_organization_custom_org_role - description: View organization roles - - name: write_organization_custom_org_role - description: Manage custom organization roles + secret_scanning_non_provider_patterns: + status: disabled organization-role-list: value: total_count: 2 @@ -203692,6 +205907,8 @@ components: status: enabled secret_scanning_push_protection: status: disabled + secret_scanning_non_provider_patterns: + status: disabled artifact-paginated: value: total_count: 2 @@ -204635,6 +206852,51 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + attestation: + value: + bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== autolink-items: value: - id: 1 @@ -209273,6 +211535,7 @@ components: filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT + copyrightText: Copyright (c) 1985 GitHub.com dependency-graph-create-snapshot-request: value: version: 0 @@ -220460,6 +222723,13 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + configuration-id: + name: configuration_id + description: The unique identifier of the code security configuration. + in: path + required: true + schema: + type: integer hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the @@ -220631,6 +222901,18 @@ components: required: true schema: type: string + ref-in-query: + name: ref + description: 'The name of the ref. Cannot contain wildcard characters. Optionally + prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to + tags. Omit the prefix to search across all refs. When specified, only rule + evaluations triggered for this ref will be returned. + + ' + in: query + schema: + type: string + x-multi-segment: true repository-name-in-query: name: repository_name description: The name of the repository to filter on. When specified, only rule @@ -221161,14 +223443,6 @@ components: required: true schema: type: integer - ref-in-query: - name: ref - description: The name of the ref. Cannot contain wildcard characters. When specified, - only rule evaluations triggered for this ref will be returned. - in: query - schema: - type: string - x-multi-segment: true tag-protection-id: name: tag_protection_id description: The unique identifier of the tag protection. @@ -221434,11 +223708,11 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" + no_content: + description: A header with no content is returned. package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - no_content: - description: A header with no content is returned. gone: description: Gone content: diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index f2efcf2e9..46b9662bd 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -410,7 +410,8 @@ export interface paths { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; put?: never; @@ -610,10 +611,15 @@ export interface paths { }; /** * List all Copilot seat assignments for an enterprise - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -636,7 +642,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -720,7 +727,8 @@ export interface paths { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; put?: never; @@ -752,7 +760,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; put?: never; @@ -780,7 +789,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; delete?: never; @@ -1120,10 +1130,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1365,7 +1373,8 @@ export interface paths { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; put?: never; @@ -1383,7 +1392,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; put?: never; post?: never; @@ -1510,7 +1523,8 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; put?: never; @@ -1536,17 +1550,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -1569,20 +1572,13 @@ export interface paths { head?: never; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -2356,6 +2352,30 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/blocks": { parameters: { query?: never; @@ -2428,6 +2448,205 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + put?: never; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/detach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + put?: never; + post?: never; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + options?: never; + head?: never; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/codespaces": { parameters: { query?: never; @@ -2656,7 +2875,8 @@ export interface paths { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -2684,7 +2904,8 @@ export interface paths { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. * Only organization owners can view assigned seats. @@ -2711,7 +2932,8 @@ export interface paths { put?: never; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2722,12 +2944,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2757,7 +2982,8 @@ export interface paths { put?: never; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2768,12 +2994,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2801,7 +3030,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3021,7 +3251,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; put?: never; post?: never; @@ -3422,10 +3656,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -3562,7 +3794,8 @@ export interface paths { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * @@ -3734,35 +3967,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/organization-fine-grained-permissions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - get: operations["orgs/list-organization-fine-grained-permissions"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/organization-roles": { parameters: { query?: never; @@ -3772,7 +3976,7 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3783,18 +3987,7 @@ export interface paths { */ get: operations["orgs/list-org-roles"]; put?: never; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - post: operations["orgs/create-custom-organization-role"]; + post?: never; delete?: never; options?: never; head?: never; @@ -3813,7 +4006,7 @@ export interface paths { post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3835,7 +4028,7 @@ export interface paths { get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3845,7 +4038,7 @@ export interface paths { post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3869,7 +4062,7 @@ export interface paths { post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3891,7 +4084,7 @@ export interface paths { get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3901,7 +4094,7 @@ export interface paths { post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3922,7 +4115,7 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3934,33 +4127,10 @@ export interface paths { get: operations["orgs/get-org-role"]; put?: never; post?: never; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - delete: operations["orgs/delete-custom-organization-role"]; + delete?: never; options?: never; head?: never; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - patch: operations["orgs/patch-custom-organization-role"]; + patch?: never; trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/teams": { @@ -3972,7 +4142,7 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3996,7 +4166,7 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -4544,7 +4714,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; put?: never; @@ -4868,7 +5039,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; put?: never; @@ -4879,7 +5051,8 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; options?: never; @@ -4888,7 +5061,8 @@ export interface paths { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; trace?: never; @@ -4904,7 +5078,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4916,7 +5091,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4938,7 +5114,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4949,7 +5126,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4960,7 +5138,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4978,7 +5157,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4990,7 +5170,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5012,7 +5193,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5023,7 +5205,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5034,7 +5217,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5052,7 +5236,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5064,7 +5249,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5087,7 +5273,8 @@ export interface paths { post?: never; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -5110,7 +5297,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5122,7 +5310,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5145,7 +5334,8 @@ export interface paths { post?: never; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -5168,7 +5358,8 @@ export interface paths { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; put?: never; @@ -5214,10 +5405,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -5228,13 +5420,15 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; post?: never; @@ -5244,9 +5438,11 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; options?: never; @@ -5265,7 +5461,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; put?: never; @@ -5287,14 +5484,16 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; post?: never; @@ -5302,7 +5501,8 @@ export interface paths { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; options?: never; @@ -5321,7 +5521,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; put?: never; @@ -5349,14 +5550,16 @@ export interface paths { * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -5366,7 +5569,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; options?: never; @@ -5385,7 +5589,8 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; put?: never; @@ -5407,7 +5612,11 @@ export interface paths { put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * @@ -5650,7 +5859,8 @@ export interface paths { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -5663,7 +5873,8 @@ export interface paths { * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -5685,7 +5896,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; put?: never; @@ -6605,8 +6817,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -7193,6 +7405,54 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/attestations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/autolinks": { parameters: { query?: never; @@ -7327,9 +7587,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; post?: never; @@ -7402,7 +7664,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; trace?: never; @@ -7420,7 +7683,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; put?: never; @@ -7518,7 +7782,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; put?: never; @@ -7680,7 +7945,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -7710,7 +7976,8 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ post: operations["checks/create"]; delete?: never; @@ -7730,7 +7997,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7744,7 +8012,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7810,7 +8079,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7853,7 +8123,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7877,7 +8148,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -8007,8 +8279,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8660,7 +8932,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -8800,7 +9073,8 @@ export interface paths { post?: never; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -8952,7 +9226,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -9009,7 +9284,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -9035,7 +9311,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -9236,7 +9513,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -9252,7 +9530,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; options?: never; @@ -9680,7 +9959,8 @@ export interface paths { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -9691,9 +9971,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -9818,7 +10100,9 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -10039,8 +10323,8 @@ export interface paths { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - * + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; put?: never; @@ -10065,9 +10349,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; delete?: never; @@ -10233,7 +10519,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -10257,7 +10544,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; put?: never; @@ -10445,8 +10733,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; put?: never; @@ -10628,7 +10916,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; delete?: never; @@ -10649,7 +10938,8 @@ export interface paths { * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -10692,8 +10982,8 @@ export interface paths { * Importing into a GitHub repository with GitHub Actions enabled is not supported and will * return a status `422 Unprocessable Entity` response. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -10702,8 +10992,8 @@ export interface paths { * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -10718,7 +11008,8 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -10737,7 +11028,8 @@ export interface paths { * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -10767,8 +11059,8 @@ export interface paths { * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -10785,8 +11077,8 @@ export interface paths { * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -10819,8 +11111,8 @@ export interface paths { * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -10924,10 +11216,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11066,7 +11356,8 @@ export interface paths { post?: never; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -11132,10 +11423,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11391,7 +11680,8 @@ export interface paths { post?: never; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ @@ -12134,7 +12424,8 @@ export interface paths { post?: never; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -12337,8 +12628,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12438,7 +12729,8 @@ export interface paths { * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -12544,9 +12836,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12786,9 +13077,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; put?: never; @@ -12882,7 +13172,8 @@ export interface paths { post?: never; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -13217,7 +13508,8 @@ export interface paths { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; delete?: never; @@ -13259,12 +13551,10 @@ export interface paths { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; put?: never; @@ -13312,7 +13602,8 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; put?: never; @@ -13470,8 +13761,8 @@ export interface paths { /** * Deprecated - List tag protection states for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13482,8 +13773,8 @@ export interface paths { /** * Deprecated - Create a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13508,8 +13799,8 @@ export interface paths { /** * Deprecated - Delete a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13532,7 +13823,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; put?: never; @@ -13728,7 +14021,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; put?: never; @@ -13871,7 +14165,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; put?: never; @@ -14006,7 +14301,8 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14014,7 +14310,8 @@ export interface paths { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14026,11 +14323,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; trace?: never; @@ -14045,7 +14344,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14056,7 +14356,8 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14081,7 +14382,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14093,7 +14395,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14105,7 +14408,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14124,7 +14428,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14135,7 +14440,8 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14160,7 +14466,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14172,7 +14479,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14184,7 +14492,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14203,7 +14512,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14214,7 +14524,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14239,7 +14550,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14250,7 +14562,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14275,7 +14588,8 @@ export interface paths { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14298,7 +14612,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14339,7 +14654,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -14356,7 +14672,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; options?: never; @@ -14374,7 +14691,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14389,13 +14707,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -14406,13 +14726,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; options?: never; @@ -14430,7 +14752,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14453,7 +14776,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14461,7 +14785,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14470,7 +14795,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14490,7 +14816,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14511,9 +14838,11 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ @@ -14521,7 +14850,8 @@ export interface paths { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14532,7 +14862,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -14552,7 +14883,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -15304,10 +15636,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -16071,6 +16401,30 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -16117,6 +16471,30 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/docker/conflicts": { parameters: { query?: never; @@ -16149,6 +16527,9 @@ export interface paths { /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; put?: never; @@ -16169,6 +16550,9 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; put?: never; @@ -16186,7 +16570,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; put?: never; post?: never; @@ -16570,7 +16958,11 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; put?: never; @@ -16588,7 +16980,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; put?: never; post?: never; @@ -16918,7 +17314,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -17104,7 +17503,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -17222,7 +17624,8 @@ export interface components { metadata: string; contents: string; deployments: string; - [key: string]: string | undefined; + } & { + [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -17866,6 +18269,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -18266,6 +18670,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -18954,6 +19359,7 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { + /** Format: int64 */ id: number; name: string; slug: string; @@ -19037,7 +19443,7 @@ export interface components { /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: { + breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language: string; /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ @@ -19052,8 +19458,9 @@ export interface components { lines_accepted: number; /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ active_users: number; + } & { [key: string]: unknown; - }[] | null; + })[] | null; }; /** @description The security alert number. */ "alert-number": number; @@ -19186,6 +19593,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -19658,7 +20066,8 @@ export interface components { metadata: string; contents: string; deployments: string; - [key: string]: string | undefined; + } & { + [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -19962,7 +20371,7 @@ export interface components { language: string; raw_url: string; size: number; - } | undefined; + }; }; public: boolean; /** Format: date-time */ @@ -19985,6 +20394,7 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -20109,7 +20519,7 @@ export interface components { language: string; raw_url: string; size: number; - } | undefined; + }; }; public: boolean; /** Format: date-time */ @@ -20135,7 +20545,7 @@ export interface components { git_push_url: string; html_url: string; files: { - [key: string]: ({ + [key: string]: { filename: string; type: string; language: string; @@ -20143,7 +20553,7 @@ export interface components { size: number; truncated: boolean; content: string; - } | null) | undefined; + } | null; }; public: boolean; created_at: string; @@ -20492,13 +20902,20 @@ export interface components { /** @enum {string} */ status: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns: { + /** @enum {string} */ + status: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -20878,47 +21295,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -21010,7 +21440,8 @@ export interface components { verified_allowed: boolean; /** @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. */ + * > [!NOTE] + * > The `patterns_allowed` setting only applies to public repositories. */ patterns_allowed: string[]; }; /** @@ -21235,7 +21666,7 @@ export interface components { * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -21243,8 +21674,6 @@ export interface components { id: string | null; /** @description The name of the rule used to detect the alert. */ name: string; - /** @description A set of tags applicable for the rule. */ - tags: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -21257,6 +21686,8 @@ export interface components { security_severity_level: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description: string; + /** @description A set of tags applicable for the rule. */ + tags: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -21321,6 +21752,102 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + target_type: "global" | "organization"; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos: "public" | "private_and_internal" | "all"; + configuration: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository: components["schemas"]["simple-repository"]; + }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -21368,7 +21895,10 @@ export interface components { * @description A codespace. */ codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -21622,6 +22152,7 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + } & { [key: string]: unknown; }; /** @@ -21670,7 +22201,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -21922,6 +22456,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -22063,7 +22598,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -22101,20 +22639,15 @@ export interface components { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - "organization-fine-grained-permission": { - name: string; - description: string; - }; /** * Organization Role * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; @@ -22374,13 +22907,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization: { - [key: string]: string | undefined; + [key: string]: string; }; repository: { - [key: string]: string | undefined; + [key: string]: string; }; other: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ @@ -22410,13 +22943,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization: { - [key: string]: string | undefined; + [key: string]: string; }; repository: { - [key: string]: string | undefined; + [key: string]: string; }; other: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -22552,6 +23085,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -22927,7 +23461,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -23301,6 +23838,11 @@ export interface components { name: string; /** @description The values to match for the repository property */ property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -23356,6 +23898,36 @@ export interface components { /** @enum {string} */ type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -23414,6 +23986,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -23565,6 +24139,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -23603,7 +24179,7 @@ export interface components { * Repository Rule * @description A repository rule. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { /** @enum {string} */ type: "file_path_restriction"; parameters?: { @@ -23644,7 +24220,8 @@ export interface components { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -24688,6 +25265,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -25106,6 +25684,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -25113,6 +25692,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -25122,6 +25702,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -25391,6 +25972,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -25440,6 +26022,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -25759,6 +26342,7 @@ export interface components { apps_url: string; users: { login: string; + /** Format: int64 */ id: number; node_id: string; avatar_url: string; @@ -26019,8 +26603,8 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -26919,7 +27503,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -26994,6 +27581,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -27030,7 +27618,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -27178,7 +27769,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -27896,6 +28490,11 @@ export interface components { * @example NOASSERTION */ supplier: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText: string; externalRefs: { /** * @description The category of reference to an external resource this reference refers to. @@ -27921,7 +28520,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: ((string | number | boolean) | null) | undefined; + [key: string]: (string | number | boolean) | null; }; dependency: { /** @@ -27964,7 +28563,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"] | undefined; + [key: string]: components["schemas"]["dependency"]; }; }; /** @@ -28022,7 +28621,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"] | undefined; + [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time @@ -28041,7 +28640,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -28125,6 +28727,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -29159,6 +29762,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -29175,14 +29779,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -29393,11 +30003,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -29629,7 +30241,7 @@ export interface components { * @description Language */ language: { - [key: string]: number | undefined; + [key: string]: number; }; /** * License Content @@ -29971,7 +30583,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -30241,6 +30856,7 @@ export interface components { gravatar_id: string | null; /** Format: uri */ html_url: string; + /** Format: int64 */ id: number; node_id: string; login: string; @@ -30416,6 +31032,7 @@ export interface components { gravatar_id: string | null; /** Format: uri */ html_url: string; + /** Format: int64 */ id: number; node_id: string; login: string; @@ -30500,6 +31117,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -30553,9 +31171,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -30757,7 +31381,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number: components["schemas"]["alert-number"]; created_at: components["schemas"]["alert-created-at"]; @@ -31632,6 +32256,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -31685,7 +32310,10 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -31901,7 +32529,10 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -32067,7 +32698,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -32103,6 +32737,7 @@ export interface components { * } * ] */ subkeys: { + /** Format: int64 */ id: number; primary_key_id: number; key_id: string; @@ -32144,6 +32779,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -32223,6 +32859,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType: string; + verificationMaterial: { + x509CertificateChain: { + certificates: { + rawBytes: string; + }[]; + }; + tlogEntries: { + logIndex: string; + logId: { + keyId: string; + }; + kindVersion: { + kind: string; + version: string; + }; + integratedTime: string; + inclusionPromise: { + signedEntryTimestamp: string; + }; + inclusionProof: string | null; + canonicalizedBody: string; + }[]; + timestampVerificationData: string | null; + }; + dsseEnvelope: { + payload: string; + payloadType: string; + signatures: { + sig: string; + keyid: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -32246,7 +32921,6 @@ export interface components { * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." - * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -32356,6 +33030,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -32946,6 +33621,13 @@ export interface components { ignore_approvals_from_contributors: boolean; /** @enum {string} */ linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -33197,6 +33879,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33267,6 +33950,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33410,6 +34094,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33430,6 +34115,7 @@ export interface components { /** Format: uri */ url?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -33479,6 +34165,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33607,6 +34294,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34024,6 +34712,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34505,6 +35194,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34702,6 +35392,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -35301,6 +35992,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35333,37 +36025,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization: { - [key: string]: string | undefined; + [key: string]: string; }; repository: { - [key: string]: string | undefined; + [key: string]: string; }; other: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization: { - [key: string]: string | undefined; + [key: string]: string; }; repository: { - [key: string]: string | undefined; + [key: string]: string; }; other: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization: { - [key: string]: string | undefined; + [key: string]: string; }; repository: { - [key: string]: string | undefined; + [key: string]: string; }; other: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @@ -35633,6 +36325,43 @@ export interface components { duration?: number | null; start_date?: string | null; }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @enum {string|null} */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -35982,7 +36711,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -36164,6 +36896,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36322,7 +37055,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -36504,6 +37240,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36840,6 +37577,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36985,6 +37723,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37057,6 +37796,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37780,6 +38520,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval: { + from: boolean | null; + }; required_status_checks: { from: string[]; }; @@ -39327,6 +40081,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39380,7 +40135,7 @@ export interface components { definition: components["schemas"]["org-custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property deleted event */ @@ -39393,7 +40148,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property updated event */ @@ -39403,7 +40158,7 @@ export interface components { definition: components["schemas"]["org-custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** Custom property values updated event */ @@ -42056,7 +42811,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -42551,6 +43309,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42960,6 +43719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43080,6 +43840,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; + /** Format: int64 */ id: number; login: string; node_id: string; @@ -43490,6 +44251,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43610,6 +44372,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; + /** Format: int64 */ id: number; login: string; node_id: string; @@ -44021,6 +44784,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44141,6 +44905,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; + /** Format: int64 */ id: number; login: string; node_id: string; @@ -44568,6 +45333,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44635,6 +45401,7 @@ export interface components { gists_url: string; gravatar_id: string; html_url: string; + /** Format: int64 */ id: number; login: string; node_id: string; @@ -45047,6 +45814,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45467,6 +46235,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45899,6 +46668,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46320,6 +47090,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46742,6 +47513,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47162,6 +47934,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47582,6 +48355,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47721,7 +48495,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48238,6 +49015,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48669,6 +49447,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49088,6 +49867,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49230,7 +50010,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49786,6 +50569,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50447,11 +51231,11 @@ export interface components { }; platform: string; metadata: { - [key: string]: string | undefined; + [key: string]: string; }; repo: string; dependencies: { - [key: string]: string | undefined; + [key: string]: string; }[]; commit_oid: string; }; @@ -51556,6 +52340,57 @@ export interface components { projects_v2: components["schemas"]["projects-v2"]; sender: components["schemas"]["simple-user-webhooks"]; }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body: { + from: string | null; + to: string | null; + }; + status: { + /** @enum {string|null} */ + from: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** @enum {string|null} */ + to: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + }; + start_date: { + /** Format: date */ + from: string | null; + /** Format: date */ + to: string | null; + }; + target_date: { + /** Format: date */ + from: string | null; + /** Format: date */ + to: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; /** public event */ "webhook-public": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -51871,7 +52706,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52053,6 +52891,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52211,7 +53050,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52393,6 +53235,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52729,6 +53572,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53059,7 +53903,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53241,6 +54088,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53399,7 +54247,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53581,6 +54432,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53917,6 +54769,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54248,7 +55101,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54430,6 +55286,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54770,6 +55627,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55106,6 +55964,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55473,7 +56332,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55655,6 +56517,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55813,7 +56676,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55995,6 +56861,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56331,6 +57198,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56693,7 +57561,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56875,6 +57746,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57033,7 +57905,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57215,6 +58090,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57551,6 +58427,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57882,7 +58759,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58064,6 +58944,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58222,7 +59103,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58404,6 +59288,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58740,6 +59625,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59070,7 +59956,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59252,6 +60141,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59410,7 +60300,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59592,6 +60485,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59928,6 +60822,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60128,6 +61023,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60448,7 +61344,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60630,6 +61529,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60781,7 +61681,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60963,6 +61866,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61248,6 +62152,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61576,7 +62481,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61758,6 +62666,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61909,7 +62818,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62091,6 +63003,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62376,6 +63289,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62705,7 +63619,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62887,6 +63804,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63038,7 +63956,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63220,6 +64141,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63505,6 +64427,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63833,7 +64756,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64015,6 +64941,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64166,7 +65093,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64348,6 +65278,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64633,6 +65564,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64707,6 +65639,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65035,7 +65968,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65176,6 +66112,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65322,7 +66259,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65463,6 +66403,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65748,6 +66689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66080,7 +67022,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66255,6 +67200,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66413,7 +67359,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66595,6 +67544,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66931,6 +67881,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67297,7 +68248,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67479,6 +68433,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67637,7 +68592,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67819,6 +68777,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68155,6 +69114,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68541,7 +69501,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68723,6 +69686,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68881,7 +69845,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69063,6 +70030,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69399,6 +70367,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69765,7 +70734,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69947,6 +70919,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70105,7 +71078,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70287,6 +71263,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70623,6 +71600,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71006,7 +71984,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71188,6 +72169,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71339,7 +72321,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71521,6 +72506,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71806,6 +72792,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72135,7 +73122,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72278,6 +73268,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72429,7 +73420,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72572,6 +73566,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72857,6 +73852,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73001,6 +73997,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73329,7 +74326,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73472,6 +74472,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73623,7 +74624,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73766,6 +74770,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74051,6 +75056,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74195,6 +75201,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74527,7 +75534,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74709,6 +75719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74867,7 +75878,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75042,6 +76056,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75378,6 +76393,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75709,7 +76725,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75891,6 +76910,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76049,7 +77069,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76231,6 +77254,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76567,6 +77591,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76898,7 +77923,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -77080,6 +78108,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77238,7 +78267,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -77413,6 +78445,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77749,6 +78782,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78079,7 +79113,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78261,6 +79298,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78419,7 +79457,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78601,6 +79642,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78937,6 +79979,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -79217,7 +80260,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -80180,6 +81226,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -80932,7 +81979,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81181,7 +82231,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81430,7 +82483,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81710,7 +82766,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81959,7 +83018,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -83921,15 +84983,15 @@ export interface components { }; }; }; - /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - package_es_list_error: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ + package_es_list_error: { headers: { [name: string]: unknown; }; @@ -84130,6 +85192,8 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -84171,6 +85235,9 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; /** @description The time period to filter by. @@ -84307,8 +85374,6 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - "ref-in-query": string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -84510,13 +85575,14 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["integration"] & { + "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; webhook_secret: string | null; pem: string; + } & { [key: string]: unknown; - }; + }); }; }; 404: components["responses"]["not_found"]; @@ -85244,7 +86310,7 @@ export interface operations { }; content: { "application/json": { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -85276,7 +86342,7 @@ export interface operations { }; content: { "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ + /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ total_seats: number; seats: components["schemas"]["copilot-seat-details"][]; }; @@ -85540,7 +86606,7 @@ export interface operations { [key: string]: { /** @description Content of the file */ content: string; - } | undefined; + }; }; public?: boolean | ("true" | "false"); }; @@ -85708,12 +86774,12 @@ export interface operations { * } */ files: { - [key: string]: ({ + [key: string]: { /** @description The new content of the file. */ content: string; /** @description The new filename for the file. */ filename: string | null; - } | null) | undefined; + } | null; }; } | null; }; @@ -87009,41 +88075,71 @@ export interface operations { web_commit_signoff_required: boolean; /** @example "http://github.blog" */ blog: string; - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ advanced_security_enabled_for_new_repositories: boolean; - /** @description Whether Dependabot alerts is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependabot_alerts_enabled_for_new_repositories: boolean; - /** @description Whether Dependabot security updates is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependabot_security_updates_enabled_for_new_repositories: boolean; - /** @description Whether dependency graph is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependency_graph_enabled_for_new_repositories: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ secret_scanning_enabled_for_new_repositories: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ secret_scanning_push_protection_enabled_for_new_repositories: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled: boolean; @@ -88300,6 +89396,53 @@ export interface operations { }; }; }; + "orgs/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations: { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle: { + mediaType: string; + verificationMaterial: { + [key: string]: unknown; + }; + dsseEnvelope: { + [key: string]: unknown; + }; + }; + repository_id: number; + }[]; + }; + }; + }; + }; + }; "orgs/list-blocked-users": { parameters: { query?: { @@ -88454,6 +89597,435 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + "code-security/get-default-configurations": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/detach-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/get-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/delete-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-security/attach-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "public" | "private_or_internal" | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + "code-security/set-configuration-as-default": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; + configuration: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "codespaces/list-in-organization": { parameters: { query?: { @@ -90830,31 +92402,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/list-organization-fine-grained-permissions": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/list-org-roles": { parameters: { query?: never; @@ -90885,43 +92432,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "orgs/create-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/revoke-all-org-roles-team": { parameters: { query?: never; @@ -91123,68 +92633,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "orgs/delete-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "orgs/patch-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/list-org-role-teams": { parameters: { query?: { @@ -92560,7 +94008,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -92590,6 +94039,9 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. @@ -92705,7 +94157,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target: "branch" | "tag" | "push"; @@ -92888,13 +94341,6 @@ export interface operations { }; content?: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; }; }; "orgs/remove-security-manager-team": { @@ -94162,10 +95608,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission: string; }; }; @@ -95185,6 +96628,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status: string; }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns: { + /** @description Can be `enabled` or `disabled`. */ + status: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -97610,6 +99058,101 @@ export interface operations { }; }; }; + "repos/create-attestation": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle: { + mediaType: string; + verificationMaterial: { + [key: string]: unknown; + }; + dsseEnvelope: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The ID of the attestation. */ + id: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations: { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle: { + mediaType: string; + verificationMaterial: { + [key: string]: unknown; + }; + dsseEnvelope: { + [key: string]: unknown; + }; + }; + repository_id: number; + }[]; + }; + }; + }; + }; + }; "repos/list-autolinks": { parameters: { query?: never; @@ -97745,7 +99288,7 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { headers: { [name: string]: unknown; @@ -97754,7 +99297,7 @@ export interface operations { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { headers: { [name: string]: unknown; @@ -99143,15 +100686,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } & ({ + } & (({ /** @enum {unknown} */ status: "completed"; + } & { [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ status: "queued" | "in_progress"; + } & { [key: string]: unknown; - }); + })); }; }; responses: { @@ -99288,15 +100833,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } | { + } | ({ /** @enum {unknown} */ status?: "completed"; + } & { [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ status: "queued" | "in_progress"; + } & { [key: string]: unknown; - }; + }); }; }; responses: { @@ -102320,7 +103867,10 @@ export interface operations { */ state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -103428,7 +104978,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -103805,8 +105355,7 @@ export interface operations { content: string; }[]; /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - * */ + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ base_tree?: string; }; }; @@ -109216,7 +110765,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -109246,7 +110796,8 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -109372,7 +110923,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target: "branch" | "tag" | "push"; @@ -115159,6 +116711,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/get-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description account_id parameter */ + account_id: components["parameters"]["account-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; "users/list": { parameters: { query?: { @@ -115211,6 +116787,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations: { + bundle: components["schemas"]["sigstore-bundle-0"]; + repository_id: number; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 76a7ce7be..054f0d22d 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -410,7 +410,8 @@ export interface paths { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; put?: never; @@ -610,10 +611,15 @@ export interface paths { }; /** * List all Copilot seat assignments for an enterprise - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. * * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -636,7 +642,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -720,7 +727,8 @@ export interface paths { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; put?: never; @@ -752,7 +760,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; put?: never; @@ -780,7 +789,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; delete?: never; @@ -1120,10 +1130,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1365,7 +1373,8 @@ export interface paths { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; put?: never; @@ -1383,7 +1392,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; put?: never; post?: never; @@ -1510,7 +1523,8 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; put?: never; @@ -1536,17 +1550,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -1569,20 +1572,13 @@ export interface paths { head?: never; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -2356,6 +2352,30 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/blocks": { parameters: { query?: never; @@ -2428,6 +2448,205 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + put?: never; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/detach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + put?: never; + post?: never; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + options?: never; + head?: never; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/codespaces": { parameters: { query?: never; @@ -2656,7 +2875,8 @@ export interface paths { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -2684,7 +2904,8 @@ export interface paths { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. * Only organization owners can view assigned seats. @@ -2711,7 +2932,8 @@ export interface paths { put?: never; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2722,12 +2944,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2757,7 +2982,8 @@ export interface paths { put?: never; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -2768,12 +2994,15 @@ export interface paths { * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * + * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -2801,7 +3030,8 @@ export interface paths { }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -3021,7 +3251,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; put?: never; post?: never; @@ -3422,10 +3656,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -3562,7 +3794,8 @@ export interface paths { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in beta and is subject to change. * * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * @@ -3734,35 +3967,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/organization-fine-grained-permissions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - get: operations["orgs/list-organization-fine-grained-permissions"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/organization-roles": { parameters: { query?: never; @@ -3772,7 +3976,7 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3783,18 +3987,7 @@ export interface paths { */ get: operations["orgs/list-org-roles"]; put?: never; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - post: operations["orgs/create-custom-organization-role"]; + post?: never; delete?: never; options?: never; head?: never; @@ -3813,7 +4006,7 @@ export interface paths { post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3835,7 +4028,7 @@ export interface paths { get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3845,7 +4038,7 @@ export interface paths { post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3869,7 +4062,7 @@ export interface paths { post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3891,7 +4084,7 @@ export interface paths { get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3901,7 +4094,7 @@ export interface paths { post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -3922,7 +4115,7 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -3934,33 +4127,10 @@ export interface paths { get: operations["orgs/get-org-role"]; put?: never; post?: never; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - delete: operations["orgs/delete-custom-organization-role"]; + delete?: never; options?: never; head?: never; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - patch: operations["orgs/patch-custom-organization-role"]; + patch?: never; trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/teams": { @@ -3972,7 +4142,7 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3996,7 +4166,7 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -4544,7 +4714,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; put?: never; @@ -4868,7 +5039,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; put?: never; @@ -4879,7 +5051,8 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; options?: never; @@ -4888,7 +5061,8 @@ export interface paths { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; trace?: never; @@ -4904,7 +5078,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4916,7 +5091,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4938,7 +5114,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4949,7 +5126,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4960,7 +5138,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -4978,7 +5157,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -4990,7 +5170,8 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5012,7 +5193,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5023,7 +5205,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5034,7 +5217,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5052,7 +5236,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5064,7 +5249,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5087,7 +5273,8 @@ export interface paths { post?: never; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -5110,7 +5297,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -5122,7 +5310,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -5145,7 +5334,8 @@ export interface paths { post?: never; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -5168,7 +5358,8 @@ export interface paths { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; put?: never; @@ -5214,10 +5405,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -5228,13 +5420,15 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; post?: never; @@ -5244,9 +5438,11 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; options?: never; @@ -5265,7 +5461,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; put?: never; @@ -5287,14 +5484,16 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; post?: never; @@ -5302,7 +5501,8 @@ export interface paths { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; options?: never; @@ -5321,7 +5521,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; put?: never; @@ -5349,14 +5550,16 @@ export interface paths { * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -5366,7 +5569,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; options?: never; @@ -5385,7 +5589,8 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; put?: never; @@ -5407,7 +5612,11 @@ export interface paths { put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * @@ -5650,7 +5859,8 @@ export interface paths { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -5663,7 +5873,8 @@ export interface paths { * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; put?: never; @@ -5685,7 +5896,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; put?: never; @@ -6605,8 +6817,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -7193,6 +7405,54 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/attestations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/autolinks": { parameters: { query?: never; @@ -7327,9 +7587,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; post?: never; @@ -7402,7 +7664,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; trace?: never; @@ -7420,7 +7683,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; put?: never; @@ -7518,7 +7782,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; put?: never; @@ -7680,7 +7945,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -7710,7 +7976,8 @@ export interface paths { * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ post: operations["checks/create"]; delete?: never; @@ -7730,7 +7997,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7744,7 +8012,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7810,7 +8079,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -7853,7 +8123,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -7877,7 +8148,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -8007,8 +8279,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -8660,7 +8932,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -8800,7 +9073,8 @@ export interface paths { post?: never; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -8952,7 +9226,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -9009,7 +9284,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -9035,7 +9311,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * > [!NOTE] + * > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -9236,7 +9513,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -9252,7 +9530,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; options?: never; @@ -9680,7 +9959,8 @@ export interface paths { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -9691,9 +9971,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -9818,7 +10100,9 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -10039,8 +10323,8 @@ export interface paths { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - * + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; put?: never; @@ -10065,9 +10349,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; delete?: never; @@ -10233,7 +10519,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -10257,7 +10544,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; put?: never; @@ -10445,8 +10733,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; put?: never; @@ -10628,7 +10916,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; delete?: never; @@ -10649,7 +10938,8 @@ export interface paths { * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -10692,8 +10982,8 @@ export interface paths { * Importing into a GitHub repository with GitHub Actions enabled is not supported and will * return a status `422 Unprocessable Entity` response. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; post?: never; @@ -10702,8 +10992,8 @@ export interface paths { * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; options?: never; @@ -10718,7 +11008,8 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -10737,7 +11028,8 @@ export interface paths { * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -10767,8 +11059,8 @@ export interface paths { * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; trace?: never; @@ -10785,8 +11077,8 @@ export interface paths { * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; put?: never; @@ -10819,8 +11111,8 @@ export interface paths { * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * + * > [!WARNING] + * > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; trace?: never; @@ -10924,10 +11216,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11066,7 +11356,8 @@ export interface paths { post?: never; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -11132,10 +11423,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -11391,7 +11680,8 @@ export interface paths { post?: never; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ @@ -12134,7 +12424,8 @@ export interface paths { post?: never; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -12337,8 +12628,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12438,7 +12729,8 @@ export interface paths { * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -12544,9 +12836,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -12786,9 +13077,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; put?: never; @@ -12882,7 +13172,8 @@ export interface paths { post?: never; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -13217,7 +13508,8 @@ export interface paths { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; delete?: never; @@ -13259,12 +13551,10 @@ export interface paths { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; put?: never; @@ -13312,7 +13602,8 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; put?: never; @@ -13470,8 +13761,8 @@ export interface paths { /** * Deprecated - List tag protection states for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. * * This returns the tag protection states of a repository. * @@ -13482,8 +13773,8 @@ export interface paths { /** * Deprecated - Create a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. * * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13508,8 +13799,8 @@ export interface paths { /** * Deprecated - Delete a tag protection state for a repository * @deprecated - * @description **Note**: This operation is deprecated and will be removed after August 30th 2024 - * Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * @description > [!WARNING] + * > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. * * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. @@ -13532,7 +13823,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; put?: never; @@ -13728,7 +14021,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; put?: never; @@ -13871,7 +14165,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; put?: never; @@ -14006,7 +14301,8 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; put?: never; @@ -14014,7 +14310,8 @@ export interface paths { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -14026,11 +14323,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; trace?: never; @@ -14045,7 +14344,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -14056,7 +14356,8 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * @@ -14081,7 +14382,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -14093,7 +14395,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -14105,7 +14408,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -14124,7 +14428,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -14135,7 +14440,8 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * @@ -14160,7 +14466,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -14172,7 +14479,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -14184,7 +14492,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -14203,7 +14512,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14214,7 +14524,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -14239,7 +14550,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14250,7 +14562,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -14275,7 +14588,8 @@ export interface paths { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -14298,7 +14612,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -14339,7 +14654,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -14356,7 +14672,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; options?: never; @@ -14374,7 +14691,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -14389,13 +14707,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -14406,13 +14726,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; options?: never; @@ -14430,7 +14752,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -14453,7 +14776,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -14461,7 +14785,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -14470,7 +14795,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -14490,7 +14816,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; put?: never; @@ -14511,9 +14838,11 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ @@ -14521,7 +14850,8 @@ export interface paths { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -14532,7 +14862,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -14552,7 +14883,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; put?: never; @@ -15304,10 +15636,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -16071,6 +16401,30 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -16117,6 +16471,30 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/docker/conflicts": { parameters: { query?: never; @@ -16149,6 +16527,9 @@ export interface paths { /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; put?: never; @@ -16169,6 +16550,9 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; put?: never; @@ -16186,7 +16570,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; put?: never; post?: never; @@ -16570,7 +16958,11 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; put?: never; @@ -16588,7 +16980,11 @@ export interface paths { path?: never; cookie?: never; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; put?: never; post?: never; @@ -16918,7 +17314,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -17104,7 +17503,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -17222,7 +17624,8 @@ export interface components { metadata?: string; contents?: string; deployments?: string; - [key: string]: string | undefined; + } & { + [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -17866,6 +18269,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -18266,6 +18670,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -18954,6 +19359,7 @@ export interface components { * @description Group of enterprise owners and/or members */ "enterprise-team": { + /** Format: int64 */ id: number; name: string; slug: string; @@ -19037,7 +19443,7 @@ export interface components { /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ total_active_chat_users?: number; /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: { + breakdown: ({ /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ language?: string; /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ @@ -19052,8 +19458,9 @@ export interface components { lines_accepted?: number; /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ active_users?: number; + } & { [key: string]: unknown; - }[] | null; + })[] | null; }; /** @description The security alert number. */ "alert-number": number; @@ -19186,6 +19593,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -19658,7 +20066,8 @@ export interface components { metadata?: string; contents?: string; deployments?: string; - [key: string]: string | undefined; + } & { + [key: string]: string; }; /** * @description The list of events for the GitHub app @@ -19962,7 +20371,7 @@ export interface components { language?: string; raw_url?: string; size?: number; - } | undefined; + }; }; public: boolean; /** Format: date-time */ @@ -19985,6 +20394,7 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -20109,7 +20519,7 @@ export interface components { language?: string; raw_url?: string; size?: number; - } | undefined; + }; }; public: boolean; /** Format: date-time */ @@ -20135,7 +20545,7 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: ({ + [key: string]: { filename?: string; type?: string; language?: string; @@ -20143,7 +20553,7 @@ export interface components { size?: number; truncated?: boolean; content?: string; - } | null) | undefined; + } | null; }; public?: boolean; created_at?: string; @@ -20492,13 +20902,20 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -20878,47 +21295,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -21010,7 +21440,8 @@ export interface components { verified_allowed?: boolean; /** @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. */ + * > [!NOTE] + * > The `patterns_allowed` setting only applies to public repositories. */ patterns_allowed?: string[]; }; /** @@ -21235,7 +21666,7 @@ export interface components { * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ - "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -21243,8 +21674,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -21257,6 +21686,8 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -21321,6 +21752,102 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + target_type?: "global" | "organization"; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -21368,7 +21895,10 @@ export interface components { * @description A codespace. */ codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -21622,6 +22152,7 @@ export interface components { * @enum {string} */ seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + } & { [key: string]: unknown; }; /** @@ -21670,7 +22201,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -21922,6 +22456,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -22063,7 +22598,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -22101,20 +22639,15 @@ export interface components { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - "organization-fine-grained-permission": { - name: string; - description: string; - }; /** * Organization Role * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; @@ -22374,13 +22907,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ @@ -22410,13 +22943,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -22552,6 +23085,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -22927,7 +23461,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -23301,6 +23838,11 @@ export interface components { name: string; /** @description The values to match for the repository property */ property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -23356,6 +23898,36 @@ export interface components { /** @enum {string} */ type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -23414,6 +23986,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -23565,6 +24139,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -23603,7 +24179,7 @@ export interface components { * Repository Rule * @description A repository rule. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { /** @enum {string} */ type: "file_path_restriction"; parameters?: { @@ -23644,7 +24220,8 @@ export interface components { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -24688,6 +25265,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -25106,6 +25684,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -25113,6 +25692,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -25122,6 +25702,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -25391,6 +25972,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -25440,6 +26022,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -25759,6 +26342,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -26019,8 +26603,8 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -26919,7 +27503,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -26994,6 +27581,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -27030,7 +27618,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -27178,7 +27769,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -27896,6 +28490,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -27921,7 +28520,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: ((string | number | boolean) | null) | undefined; + [key: string]: (string | number | boolean) | null; }; dependency: { /** @@ -27964,7 +28563,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"] | undefined; + [key: string]: components["schemas"]["dependency"]; }; }; /** @@ -28022,7 +28621,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"] | undefined; + [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time @@ -28041,7 +28640,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -28125,6 +28727,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -29159,6 +29762,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -29175,14 +29779,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -29393,11 +30003,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -29629,7 +30241,7 @@ export interface components { * @description Language */ language: { - [key: string]: number | undefined; + [key: string]: number; }; /** * License Content @@ -29971,7 +30583,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -30241,6 +30856,7 @@ export interface components { gravatar_id: string | null; /** Format: uri */ html_url: string; + /** Format: int64 */ id: number; node_id: string; login: string; @@ -30416,6 +31032,7 @@ export interface components { gravatar_id: string | null; /** Format: uri */ html_url: string; + /** Format: int64 */ id: number; node_id: string; login: string; @@ -30500,6 +31117,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -30553,9 +31171,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -30757,7 +31381,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -31632,6 +32256,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -31685,7 +32310,10 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -31901,7 +32529,10 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -32067,7 +32698,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -32103,6 +32737,7 @@ export interface components { * } * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -32144,6 +32779,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -32223,6 +32859,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType?: string; + verificationMaterial?: { + x509CertificateChain?: { + certificates?: { + rawBytes?: string; + }[]; + }; + tlogEntries?: { + logIndex?: string; + logId?: { + keyId?: string; + }; + kindVersion?: { + kind?: string; + version?: string; + }; + integratedTime?: string; + inclusionPromise?: { + signedEntryTimestamp?: string; + }; + inclusionProof?: string | null; + canonicalizedBody?: string; + }[]; + timestampVerificationData?: string | null; + }; + dsseEnvelope?: { + payload?: string; + payloadType?: string; + signatures?: { + sig?: string; + keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -32246,7 +32921,6 @@ export interface components { * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." - * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -32356,6 +33030,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -32946,6 +33621,13 @@ export interface components { ignore_approvals_from_contributors: boolean; /** @enum {string} */ linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -33197,6 +33879,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33267,6 +33950,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33410,6 +34094,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33430,6 +34115,7 @@ export interface components { /** Format: uri */ url?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -33479,6 +34165,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33607,6 +34294,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34024,6 +34712,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34505,6 +35194,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34702,6 +35392,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -35301,6 +35992,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35333,37 +36025,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization?: { - [key: string]: string | undefined; + [key: string]: string; }; repository?: { - [key: string]: string | undefined; + [key: string]: string; }; other?: { - [key: string]: string | undefined; + [key: string]: string; }; }; /** @@ -35633,6 +36325,43 @@ export interface components { duration?: number | null; start_date?: string | null; }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @enum {string|null} */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -35982,7 +36711,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -36164,6 +36896,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36322,7 +37055,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -36504,6 +37240,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36840,6 +37577,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36985,6 +37723,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37057,6 +37796,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37780,6 +38520,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -39327,6 +40081,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39380,7 +40135,7 @@ export interface components { definition: components["schemas"]["org-custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property deleted event */ @@ -39393,7 +40148,7 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** custom property updated event */ @@ -39403,7 +40158,7 @@ export interface components { definition: components["schemas"]["org-custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; /** Custom property values updated event */ @@ -42056,7 +42811,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -42551,6 +43309,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42960,6 +43719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43080,6 +43840,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -43490,6 +44251,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43610,6 +44372,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -44021,6 +44784,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44141,6 +44905,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -44568,6 +45333,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44635,6 +45401,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -45047,6 +45814,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45467,6 +46235,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45899,6 +46668,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46320,6 +47090,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46742,6 +47513,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47162,6 +47934,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47582,6 +48355,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47721,7 +48495,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48238,6 +49015,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48669,6 +49447,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49088,6 +49867,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49230,7 +50010,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49786,6 +50569,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50447,11 +51231,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; repo?: string; dependencies?: { - [key: string]: string | undefined; + [key: string]: string; }[]; commit_oid?: string; }; @@ -51556,6 +52340,57 @@ export interface components { projects_v2: components["schemas"]["projects-v2"]; sender: components["schemas"]["simple-user-webhooks"]; }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; + }; + status?: { + /** @enum {string|null} */ + from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** @enum {string|null} */ + to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + }; + start_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + target_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; /** public event */ "webhook-public": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -51871,7 +52706,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52053,6 +52891,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52211,7 +53050,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52393,6 +53235,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52729,6 +53572,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53059,7 +53903,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53241,6 +54088,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53399,7 +54247,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53581,6 +54432,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53917,6 +54769,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54248,7 +55101,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54430,6 +55286,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54770,6 +55627,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55106,6 +55964,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55473,7 +56332,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55655,6 +56517,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55813,7 +56676,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55995,6 +56861,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56331,6 +57198,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56693,7 +57561,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56875,6 +57746,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57033,7 +57905,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57215,6 +58090,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57551,6 +58427,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57882,7 +58759,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58064,6 +58944,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58222,7 +59103,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58404,6 +59288,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58740,6 +59625,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59070,7 +59956,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59252,6 +60141,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59410,7 +60300,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59592,6 +60485,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59928,6 +60822,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60128,6 +61023,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60448,7 +61344,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60630,6 +61529,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60781,7 +61681,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60963,6 +61866,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61248,6 +62152,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61576,7 +62481,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61758,6 +62666,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61909,7 +62818,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62091,6 +63003,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62376,6 +63289,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62705,7 +63619,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62887,6 +63804,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63038,7 +63956,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63220,6 +64141,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63505,6 +64427,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63833,7 +64756,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64015,6 +64941,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64166,7 +65093,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64348,6 +65278,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64633,6 +65564,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64707,6 +65639,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65035,7 +65968,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65176,6 +66112,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65322,7 +66259,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65463,6 +66403,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65748,6 +66689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66080,7 +67022,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66255,6 +67200,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66413,7 +67359,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66595,6 +67544,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66931,6 +67881,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67297,7 +68248,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67479,6 +68433,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67637,7 +68592,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67819,6 +68777,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68155,6 +69114,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68541,7 +69501,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68723,6 +69686,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68881,7 +69845,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69063,6 +70030,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69399,6 +70367,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69765,7 +70734,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69947,6 +70919,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70105,7 +71078,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70287,6 +71263,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70623,6 +71600,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71006,7 +71984,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71188,6 +72169,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71339,7 +72321,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71521,6 +72506,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71806,6 +72792,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72135,7 +73122,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72278,6 +73268,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72429,7 +73420,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72572,6 +73566,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72857,6 +73852,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73001,6 +73997,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73329,7 +74326,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73472,6 +74472,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73623,7 +74624,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73766,6 +74770,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74051,6 +75056,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74195,6 +75201,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74527,7 +75534,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74709,6 +75719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74867,7 +75878,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75042,6 +76056,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75378,6 +76393,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75709,7 +76725,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75891,6 +76910,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76049,7 +77069,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76231,6 +77254,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76567,6 +77591,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76898,7 +77923,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -77080,6 +78108,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77238,7 +78267,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -77413,6 +78445,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77749,6 +78782,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78079,7 +79113,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78261,6 +79298,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78419,7 +79457,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78601,6 +79642,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -78937,6 +79979,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -79217,7 +80260,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -80180,6 +81226,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -80932,7 +81979,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81181,7 +82231,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81430,7 +82483,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81710,7 +82766,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -81959,7 +83018,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -83921,15 +84983,15 @@ export interface components { }; }; }; - /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - package_es_list_error: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ + package_es_list_error: { headers: { [name: string]: unknown; }; @@ -84130,6 +85192,8 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -84171,6 +85235,9 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; /** @description The time period to filter by. @@ -84307,8 +85374,6 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - "ref-in-query": string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -84510,13 +85575,14 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["integration"] & { + "application/json": components["schemas"]["integration"] & ({ client_id: string; client_secret: string; webhook_secret: string | null; pem: string; + } & { [key: string]: unknown; - }; + }); }; }; 404: components["responses"]["not_found"]; @@ -85244,7 +86310,7 @@ export interface operations { }; content: { "application/json": { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -85276,7 +86342,7 @@ export interface operations { }; content: { "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ + /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ total_seats?: number; seats?: components["schemas"]["copilot-seat-details"][]; }; @@ -85540,7 +86606,7 @@ export interface operations { [key: string]: { /** @description Content of the file */ content: string; - } | undefined; + }; }; public?: boolean | ("true" | "false"); }; @@ -85708,12 +86774,12 @@ export interface operations { * } */ files?: { - [key: string]: ({ + [key: string]: { /** @description The new content of the file. */ content?: string; /** @description The new filename for the file. */ filename?: string | null; - } | null) | undefined; + } | null; }; } | null; }; @@ -87009,41 +88075,71 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot security updates is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** @description Whether dependency graph is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ dependency_graph_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. + /** + * @deprecated + * @description **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -88300,6 +89396,53 @@ export interface operations { }; }; }; + "orgs/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + }[]; + }; + }; + }; + }; + }; "orgs/list-blocked-users": { parameters: { query?: { @@ -88454,6 +89597,435 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + "code-security/get-default-configurations": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/detach-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/get-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/delete-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-security/attach-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "public" | "private_or_internal" | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + "code-security/set-configuration-as-default": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "codespaces/list-in-organization": { parameters: { query?: { @@ -90830,31 +92402,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/list-organization-fine-grained-permissions": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/list-org-roles": { parameters: { query?: never; @@ -90885,43 +92432,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "orgs/create-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/revoke-all-org-roles-team": { parameters: { query?: never; @@ -91123,68 +92633,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "orgs/delete-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "orgs/patch-custom-organization-role": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; "orgs/list-org-role-teams": { parameters: { query?: { @@ -92560,7 +94008,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -92590,6 +94039,9 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ + ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. @@ -92705,7 +94157,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -92888,13 +94341,6 @@ export interface operations { }; content?: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; }; }; "orgs/remove-security-manager-team": { @@ -94162,10 +95608,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -95185,6 +96628,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -97610,6 +99058,101 @@ export interface operations { }; }; }; + "repos/create-attestation": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The ID of the attestation. */ + id?: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { + /** @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + }[]; + }; + }; + }; + }; + }; "repos/list-autolinks": { parameters: { query?: never; @@ -97745,7 +99288,7 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { headers: { [name: string]: unknown; @@ -97754,7 +99297,7 @@ export interface operations { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { headers: { [name: string]: unknown; @@ -99143,15 +100686,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } & ({ + } & (({ /** @enum {unknown} */ status: "completed"; + } & { [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ status?: "queued" | "in_progress"; + } & { [key: string]: unknown; - }); + })); }; }; responses: { @@ -99288,15 +100833,17 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } | { + } | ({ /** @enum {unknown} */ status?: "completed"; + } & { [key: string]: unknown; - } | { + }) | ({ /** @enum {unknown} */ status?: "queued" | "in_progress"; + } & { [key: string]: unknown; - }; + }); }; }; responses: { @@ -102320,7 +103867,10 @@ export interface operations { */ state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -103428,7 +104978,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -103805,8 +105355,7 @@ export interface operations { content?: string; }[]; /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - * */ + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ base_tree?: string; }; }; @@ -109216,7 +110765,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -109246,7 +110796,8 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + * */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -109372,7 +110923,8 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * > [!NOTE] + * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -115159,6 +116711,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/get-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description account_id parameter */ + account_id: components["parameters"]["account-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; "users/list": { parameters: { query?: { @@ -115211,6 +116787,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { + bundle?: components["schemas"]["sigstore-bundle-0"]; + repository_id?: number; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index a9615b538..9ca7de218 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -1104,9 +1104,9 @@ paths: "/apps/{app_slug}": get: summary: Get an app - description: "**Note**: The `:app_slug` is just the URL-friendly name of your - GitHub App. You can find this on the settings page for your GitHub App (e.g., - `https://github.com/settings/apps/:app_slug`)." + description: |- + > [!NOTE] + > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). tags: - apps operationId: apps/get-by-slug @@ -1420,10 +1420,15 @@ paths: get: summary: List all Copilot seat assignments for an enterprise description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + + For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -1453,8 +1458,9 @@ paths: properties: total_seats: type: integer - description: Total number of Copilot seats for the organization - currently being billed. + description: The total number of Copilot seats the enterprise + is being billed for. Users with access through multiple organizations + or enterprise teams are only counted once. seats: type: array items: @@ -1482,7 +1488,8 @@ paths: get: summary: Get a summary of Copilot usage for enterprise members description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -1664,9 +1671,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -1715,7 +1722,8 @@ paths: By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + > [!NOTE] + > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity operationId: activity/get-feeds @@ -1782,7 +1790,8 @@ paths: description: |- Allows you to add a new gist with one or more files. - **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + > [!NOTE] + > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. operationId: gists/create tags: - gists @@ -2744,10 +2753,8 @@ paths: repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -3316,7 +3323,8 @@ paths: The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. - **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + > [!NOTE] + > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. tags: - meta operationId: meta/get @@ -3344,7 +3352,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -3729,7 +3739,8 @@ paths: description: |- Lists all organizations, in the order that they were created. - **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + > [!NOTE] + > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: - orgs operationId: orgs/list @@ -3773,17 +3784,6 @@ paths: To see the full details about an organization, the authenticated user must be an organization owner. - The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - - - advanced_security_enabled_for_new_repositories - - dependabot_alerts_enabled_for_new_repositories - - dependabot_security_updates_enabled_for_new_repositories - - dependency_graph_enabled_for_new_repositories - - secret_scanning_enabled_for_new_repositories - - secret_scanning_push_protection_enabled_for_new_repositories - - For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -3815,20 +3815,13 @@ paths: patch: summary: Update an organization description: |- - **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + > [!WARNING] + > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - Updates the organization's profile and member privileges. - - With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - - - advanced_security_enabled_for_new_repositories - - dependabot_alerts_enabled_for_new_repositories - - dependabot_security_updates_enabled_for_new_repositories - - dependency_graph_enabled_for_new_repositories - - secret_scanning_enabled_for_new_repositories - - secret_scanning_push_protection_enabled_for_new_repositories + > [!WARNING] + > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). - For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + Updates the organization's profile and member privileges. The authenticated user must be an organization owner to use this endpoint. @@ -3962,51 +3955,69 @@ paths: advanced_security_enabled_for_new_repositories: type: boolean description: |- - Whether GitHub Advanced Security is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- - Whether Dependabot alerts is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- - Whether Dependabot security updates is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean description: |- - Whether dependency graph is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean description: |- - Whether secret scanning is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- - Whether secret scanning push protection is automatically enabled for new repositories. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true secret_scanning_push_protection_custom_link_enabled: type: boolean description: Whether a custom link is shown to contributors who @@ -5849,6 +5860,73 @@ paths: enabledForGitHubApps: true category: actions subcategory: variables + "/orgs/{org}/attestations/{subject_digest}": + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-attestations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + examples: + default: + "$ref": "#/components/examples/list-attestations" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/blocks": get: summary: List users blocked by an organization @@ -6024,6 +6102,697 @@ paths: enabledForGitHubApps: true category: code-scanning subcategory: code-scanning + "/orgs/{org}/code-security/configurations": + get: + summary: Get code security configurations for an organization + description: |- + Lists all code security configurations available in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: target_type + in: query + description: The target type of the code security configuration + required: false + schema: + type: string + enum: + - global + - all + default: all + - name: per_page + in: query + description: The number of results per page (max 100). For more information, + see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + required: false + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration-list" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + post: + summary: Create a code security configuration + description: |- + Creates a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + default: disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/defaults": + get: + summary: Get default code security configurations + description: |- + Lists the default code security configurations for an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-default-configurations" + examples: + default: + "$ref": "#/components/examples/code-security-default-configurations" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/detach": + delete: + summary: Detach configurations from repositories + description: |- + Detach code security configuration(s) from a set of repositories. + Repositories will retain their settings but will no longer be associated with the configuration. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/detach-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + selected_repository_ids: + type: array + description: An array of repository IDs to detach from configurations. + items: + type: integer + description: Unique identifier of the repository. + examples: + default: + summary: Example for detaching repositories from configurations. + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + "$ref": "#/components/responses/no_content" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}": + get: + summary: Get a code security configuration + description: |- + Gets a code security configuration available in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + patch: + summary: Update a code security configuration + description: |- + Updates a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/update-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-org recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled + responses: + '200': + description: Response when a configuration is updated + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/code-security-configuration-updated" + '204': + description: Response when no new updates are made + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + delete: + summary: Delete a code security configuration + description: |- + Deletes the desired code security configuration from an organization. + Repositories attached to the configuration will retain their settings but will no longer be associated with + the configuration. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + responses: + '204': + "$ref": "#/components/responses/no_content" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": + post: + summary: Attach a configuration to repositories + description: |- + Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + + If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration + to. `selected` means the configuration will be attached to only + the repositories specified by `selected_repository_ids` + enum: + - all + - public + - private_or_internal + - selected + selected_repository_ids: + type: array + description: An array of repository IDs to attach the configuration + to. You can only provide a list of repository ids when the `scope` + is set to `selected`. + items: + type: integer + description: Unique identifier of the repository. + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: selected + selected_repository_ids: + - 32 + - 91 + responses: + '202': + "$ref": "#/components/responses/accepted" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": + put: + summary: Set a code security configuration as a default for an organization + description: |- + Sets a code security configuration as a default to be applied to new repositories in your organization. + + This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specify which types of repository this security configuration + should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: Set this configuration to be enabled by default on all new + repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specifies which types of repository this security + configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + value: + default_for_new_repos: all + configuration: + "$ref": "#/components/examples/code-security-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": + get: + summary: Get repositories associated with a code security configuration + description: |- + Lists the repositories associated with a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-repositories-for-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/configuration-id" + - name: per_page + description: The number of results per page (max 100). For more information, + see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: status + description: |- + A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + + Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + in: query + required: false + schema: + type: string + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-security-configuration-repositories" + examples: + default: + summary: Example of code security configuration repositories + value: + - status: attached + repository: + "$ref": "#/components/examples/simple-repository" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations "/orgs/{org}/codespaces": get: summary: List codespaces for the organization @@ -6654,7 +7423,8 @@ paths: get: summary: Get Copilot seat information and settings for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -6700,7 +7470,8 @@ paths: get: summary: List all Copilot seat assignments for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. Only organization owners can view assigned seats. @@ -6761,7 +7532,8 @@ paths: post: summary: Add teams to the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -6772,6 +7544,8 @@ paths: For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + The response will contain the total number of new seats that were created and existing seats that were refreshed. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -6842,7 +7616,8 @@ paths: delete: summary: Remove teams from the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Cancels the Copilot seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -6924,7 +7699,8 @@ paths: post: summary: Add users to the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Purchases a GitHub Copilot seat for each user specified. The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -6935,6 +7711,8 @@ paths: For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + The response will contain the total number of new seats that were created and existing seats that were refreshed. + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot @@ -7005,7 +7783,8 @@ paths: delete: summary: Remove users from the Copilot subscription for an organization description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Cancels the Copilot seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -7088,7 +7867,8 @@ paths: get: summary: Get a summary of Copilot usage for organization members description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -7625,7 +8405,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -8609,10 +9391,8 @@ paths: description: |- List issues in an organization assigned to the authenticated user. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -8946,7 +9726,8 @@ paths: get: summary: Get Copilot seat assignment details for a user description: |- - **Note**: This endpoint is in beta and is subject to change. + > [!NOTE] + > This endpoint is in beta and is subject to change. Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. @@ -9424,54 +10205,11 @@ paths: enabledForGitHubApps: false category: migrations subcategory: orgs - "/orgs/{org}/organization-fine-grained-permissions": - get: - summary: List organization fine-grained permissions for an organization - description: |- - Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-organization-fine-grained-permissions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization - parameters: - - "$ref": "#/components/parameters/org" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/organization-fine-grained-permission" - examples: - default: - "$ref": "#/components/examples/organization-fine-grained-permission-example" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles "/orgs/{org}/organization-roles": get: summary: Get all organization roles for an organization description: |- - Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: @@ -9516,106 +10254,11 @@ paths: enabledForGitHubApps: true category: orgs subcategory: organization-roles - post: - summary: Create a custom organization role - description: |- - Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/create-custom-organization-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the custom role. - description: - type: string - description: A short description about the intended usage of this - role or what permissions it grants. - permissions: - type: array - description: A list of additional permissions included in this role. - items: - type: string - required: - - name - - permissions - examples: - default: - value: - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/organization-role" - examples: - default: - value: - id: 8030 - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:19:11Z' - '422': - "$ref": "#/components/responses/validation_failed" - '404': - "$ref": "#/components/responses/not_found" - '409': - "$ref": "#/components/responses/conflict" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles "/orgs/{org}/organization-roles/teams/{team_slug}": delete: summary: Remove all organization roles for a team description: |- - Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9641,7 +10284,7 @@ paths: put: summary: Assign an organization role to a team description: |- - Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9672,7 +10315,7 @@ paths: delete: summary: Remove an organization role from a team description: |- - Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9699,7 +10342,7 @@ paths: delete: summary: Remove all organization roles for a user description: |- - Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9725,7 +10368,7 @@ paths: put: summary: Assign an organization role to a user description: |- - Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9757,7 +10400,7 @@ paths: delete: summary: Remove an organization role from a user description: |- - Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. @@ -9784,7 +10427,7 @@ paths: get: summary: Get an organization role description: |- - Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: @@ -9820,127 +10463,11 @@ paths: enabledForGitHubApps: true category: orgs subcategory: organization-roles - patch: - summary: Update a custom organization role - description: |- - Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/patch-custom-organization-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/role-id" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the custom role. - description: - type: string - description: A short description about the intended usage of this - role or what permissions it grants. - permissions: - type: array - description: A list of additional permissions included in this role. - items: - type: string - examples: - default: - value: - description: Permissions to manage custom roles within an org. - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/organization-role" - examples: - default: - value: - id: 8030 - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:19:11Z' - '422': - "$ref": "#/components/responses/validation_failed" - '409': - "$ref": "#/components/responses/conflict" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - delete: - summary: Delete a custom organization role. - description: |- - Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/delete-custom-organization-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/role-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles "/orgs/{org}/organization-roles/{role_id}/teams": get: summary: List teams that are assigned to an organization role description: |- - Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -9986,7 +10513,7 @@ paths: get: summary: List users that are assigned to an organization role description: |- - Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. @@ -11561,7 +12088,8 @@ paths: description: |- Lists repositories for the specified organization. - **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > [!NOTE] + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/list-for-org @@ -11904,7 +12432,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -11983,6 +12512,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/ref-in-query" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/actor-name-in-query" @@ -12117,7 +12647,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -12389,9 +12920,6 @@ paths: responses: '204': description: Response - '409': - description: The organization has reached the maximum number of security - manager teams. x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12662,7 +13190,8 @@ paths: description: |- Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/get-by-name @@ -12694,7 +13223,8 @@ paths: description: |- To edit a team, the authenticated user must either be an organization owner or a team maintainer. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/update-in-org @@ -12797,7 +13327,8 @@ paths: If you are an organization owner, deleting a parent team will delete all of its child teams as well. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/delete-in-org @@ -12821,7 +13352,8 @@ paths: description: |- List all discussions on a team's page. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -12869,7 +13401,8 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -12931,7 +13464,8 @@ paths: description: |- Get a specific discussion on a team's page. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -12964,7 +13498,8 @@ paths: description: |- Edits the title and body text of a discussion post. Only the parameters you provide are updated. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13014,7 +13549,8 @@ paths: description: |- Delete a discussion from a team's page. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13041,7 +13577,8 @@ paths: description: |- List all comments on a team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13084,7 +13621,8 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13135,7 +13673,8 @@ paths: description: |- Get a specific comment on a team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13169,7 +13708,8 @@ paths: description: |- Edits the body text of a discussion comment. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13219,7 +13759,8 @@ paths: description: |- Deletes a comment on a team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13247,7 +13788,8 @@ paths: description: |- List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13306,7 +13848,8 @@ paths: A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13375,7 +13918,8 @@ paths: delete: summary: Delete team discussion comment reaction description: |- - **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -13406,7 +13950,8 @@ paths: description: |- List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: @@ -13464,7 +14009,8 @@ paths: A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: @@ -13531,7 +14077,8 @@ paths: delete: summary: Delete team discussion reaction description: |- - **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -13561,7 +14108,8 @@ paths: description: |- The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. tags: - teams operationId: teams/list-pending-invitations-in-org @@ -13650,10 +14198,11 @@ paths: To get a user's membership with a team, the team must be visible to the authenticated user. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - **Note:** - The response contains the `state` of the membership and the member's `role`. + > [!NOTE] + > The response contains the `state` of the membership and the member's `role`. The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). tags: @@ -13690,13 +14239,15 @@ paths: Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. tags: - teams operationId: teams/add-or-update-membership-for-user-in-org @@ -13753,9 +14304,11 @@ paths: Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. tags: - teams operationId: teams/remove-membership-for-user-in-org @@ -13782,7 +14335,8 @@ paths: description: |- Lists the organization projects for a team. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. tags: - teams operationId: teams/list-projects-in-org @@ -13820,7 +14374,8 @@ paths: description: |- Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. tags: - teams operationId: teams/check-permissions-for-project-in-org @@ -13853,7 +14408,8 @@ paths: description: |- Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. tags: - teams operationId: teams/add-or-update-project-permissions-in-org @@ -13918,7 +14474,8 @@ paths: description: |- Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. tags: - teams operationId: teams/remove-project-in-org @@ -13943,7 +14500,8 @@ paths: description: |- Lists a team's repositories visible to the authenticated user. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: - teams operationId: teams/list-repos-in-org @@ -13987,7 +14545,8 @@ paths: If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams operationId: teams/check-permissions-for-repo-in-org @@ -14025,7 +14584,8 @@ paths: description: |- To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". tags: @@ -14055,7 +14615,6 @@ paths: If no permission is specified, the team''s `permission` attribute will be used to determine what permission to grant the team on this repository.' - default: push examples: default: summary: Adding a team to an organization repository with the write @@ -14075,7 +14634,8 @@ paths: description: |- If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams operationId: teams/remove-repo-in-org @@ -14101,7 +14661,8 @@ paths: description: |- Lists the child teams of the team specified by `{team_slug}`. - **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. tags: - teams operationId: teams/list-child-in-org @@ -14137,6 +14698,9 @@ paths: post: summary: Enable or disable a security feature for an organization description: |- + > [!WARNING] + > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -14181,6 +14745,9 @@ paths: previews: [] category: orgs subcategory: orgs + deprecationDate: '2024-07-22' + removalDate: '2025-07-22' + deprecated: true "/projects/columns/cards/{card_id}": get: summary: Get a project card @@ -15201,7 +15768,8 @@ paths: get: summary: Get rate limit status for the authenticated user description: |- - **Note:** Accessing this endpoint does not count against your REST API rate limit. + > [!NOTE] + > Accessing this endpoint does not count against your REST API rate limit. Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -15214,7 +15782,8 @@ paths: * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." - **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + > [!NOTE] + > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit operationId: rate-limit/get @@ -15254,7 +15823,8 @@ paths: description: |- The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. - **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > [!NOTE] + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/get @@ -15370,6 +15940,15 @@ paths: status: type: string description: Can be `enabled` or `disabled`. + secret_scanning_non_provider_patterns: + type: object + description: Use the `status` property to enable or disable + secret scanning non-provider patterns for this repository. + For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. has_issues: type: boolean description: Either `true` to enable issues for this repository @@ -17336,8 +17915,8 @@ paths: description: |- Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - **Note:** GitHub Apps can only review their own custom deployment protection rules. - To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + > [!NOTE] + > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: @@ -18622,6 +19201,146 @@ paths: enabledForGitHubApps: true category: issues subcategory: assignees + "/repos/{owner}/{repo}/attestations": + post: + summary: Create an attestation + description: |- + Store an artifact attestation and associate it with a repository. + + The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/create-attestation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#create-an-attestation + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + required: + - bundle + examples: + default: + summary: Example of a request body + value: + "$ref": "#/components/examples/attestation" + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: integer + description: The ID of the attestation. + examples: + default: + value: + id: 2 + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + "/repos/{owner}/{repo}/attestations/{subject_digest}": + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with a repository. + + The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-attestations + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + examples: + default: + "$ref": "#/components/examples/list-attestations" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos "/repos/{owner}/{repo}/autolinks": get: summary: Get all autolinks of a repository @@ -18800,7 +19519,7 @@ paths: - "$ref": "#/components/parameters/repo" responses: '200': - description: Response if dependabot is enabled + description: Response if Dependabot is enabled content: application/json: schema: @@ -18811,7 +19530,7 @@ paths: enabled: true paused: false '404': - description: Not Found if dependabot is not enabled for the repository + description: Not Found if Dependabot is not enabled for the repository x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18981,9 +19700,11 @@ paths: Protecting a branch requires admin or owner permissions to the repository. - **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + > [!NOTE] + > Passing new arrays of `users` and `teams` replaces their previous values. - **Note**: The list of users, apps, and teams in total is limited to 100 items. + > [!NOTE] + > The list of users, apps, and teams in total is limited to 100 items. tags: - repos operationId: repos/update-branch-protection @@ -19413,7 +20134,8 @@ paths: Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + > [!NOTE] + > Passing new arrays of `users` and `teams` replaces their previous values. tags: - repos operationId: repos/update-pull-request-review-protection @@ -19568,7 +20290,8 @@ paths: When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. - **Note**: You must enable branch protection to require signed commits. + > [!NOTE] + > You must enable branch protection to require signed commits. tags: - repos operationId: repos/get-commit-signature-protection @@ -20048,7 +20771,8 @@ paths: Lists who has access to this protected branch. - **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + > [!NOTE] + > Users, apps, and teams `restrictions` are only available for organization-owned repositories. tags: - repos operationId: repos/get-access-restrictions @@ -20796,7 +21520,8 @@ paths: description: |- Renames a branch in a repository. - **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + > [!NOTE] + > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. @@ -20858,7 +21583,8 @@ paths: In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. tags: - checks operationId: checks/create @@ -21162,7 +21888,8 @@ paths: description: |- Gets a single check run using its `id`. - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -21195,7 +21922,8 @@ paths: description: |- Updates a check run for a specific commit in a repository. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: @@ -21551,7 +22279,8 @@ paths: description: |- Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: @@ -21671,7 +22400,8 @@ paths: description: |- Gets a single check suite using its `id`. - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -21705,7 +22435,8 @@ paths: description: |- Lists check runs for a check suite using its `id`. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -22024,8 +22755,8 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - **Deprecation notice**: - The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + > [!WARNING] + > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/list-recent-analyses @@ -23713,7 +24444,8 @@ paths: - If the user had their own fork of the repository, the fork will be deleted. - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + > [!NOTE] + > A user can still have access to the repository through organization permissions like base repository permissions. Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. @@ -24062,7 +24794,8 @@ paths: delete: summary: Delete a commit comment reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). tags: @@ -24407,7 +25140,8 @@ paths: description: |- Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + > [!NOTE] + > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. @@ -24486,7 +25220,8 @@ paths: description: |- Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. @@ -24555,7 +25290,8 @@ paths: description: |- Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: @@ -24921,7 +25657,8 @@ paths: description: |- Creates a new file or replaces an existing file in a repository. - **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > [!NOTE] + > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: @@ -25061,7 +25798,8 @@ paths: You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + > [!NOTE] + > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file @@ -26103,11 +26841,11 @@ paths: - success target_url: type: string - description: The target URL to associate with this status. This - URL should contain output to keep the user updated while the task - is running or serve as historical information for what happened - in the deployment. **Note:** It's recommended to use the `log_url` - parameter, which replaces `target_url`. + description: |- + The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + + > [!NOTE] + > It's recommended to use the `log_url` parameter, which replaces `target_url`. default: '' log_url: type: string @@ -26317,7 +27055,8 @@ paths: get: summary: Get an environment description: |- - **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + > [!NOTE] + > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." Anyone with read access to the repository can use this endpoint. @@ -26352,9 +27091,11 @@ paths: description: |- Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." - **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + > [!NOTE] + > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + > [!NOTE] + > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -26788,7 +27529,9 @@ paths: get: summary: List custom deployment rule integrations available for an environment description: |- - Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + Gets all custom deployment protection rule integrations that are available for an environment. + + The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." @@ -27317,8 +28060,9 @@ paths: "/repos/{owner}/{repo}/events": get: summary: List repository events - description: "**Note**: This API is not built to serve real-time use cases. - Depending on the time of day, event latency can be anywhere from 30s to 6h.\n" + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-repo-events @@ -27401,9 +28145,11 @@ paths: description: |- Create a fork for the authenticated user. - **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + > [!NOTE] + > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + > [!NOTE] + > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. tags: - repos operationId: repos/create-fork @@ -27632,10 +28378,11 @@ paths: description: The SHA of the tree object this commit points to parents: type: array - description: The SHAs of the commits that were the parents of this - commit. If omitted or empty, the commit will be written as a root - commit. For a single parent, an array of one SHA should be provided; - for a merge commit, an array of more than one should be provided. + description: The full SHAs of the commits that were the parents + of this commit. If omitted or empty, the commit will be written + as a root commit. For a single parent, an array of one SHA should + be provided; for a merge commit, an array of more than one should + be provided. items: type: string author: @@ -27818,7 +28565,8 @@ paths: When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. tags: @@ -27859,7 +28607,8 @@ paths: description: |- Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". tags: - git operationId: git/get-ref @@ -28298,7 +29047,7 @@ paths: Using both `tree.sha` and `content` will return an error." base_tree: type: string - description: | + description: |- The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. required: @@ -28348,8 +29097,8 @@ paths: If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - - **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + > [!NOTE] + > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. tags: - git operationId: git/get-tree @@ -28877,7 +29626,8 @@ paths: description: |- This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + > [!NOTE] + > Previously `/repos/:owner/:repo/hooks/:hook_id/test` tags: - repos operationId: repos/test-push-webhook @@ -28904,7 +29654,8 @@ paths: description: |- View the progress of an import. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** @@ -28971,12 +29722,13 @@ paths: deprecated: true put: summary: Start an import - description: | + description: |- Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import @@ -29067,7 +29819,8 @@ paths: have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import @@ -29146,10 +29899,11 @@ paths: deprecated: true delete: summary: Cancel an import - description: | + description: |- Stop an import for a repository. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import @@ -29180,7 +29934,8 @@ paths: This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors @@ -29218,11 +29973,12 @@ paths: "/repos/{owner}/{repo}/import/authors/{author_id}": patch: summary: Map a commit author - description: | + description: |- Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author @@ -29283,10 +30039,11 @@ paths: "/repos/{owner}/{repo}/import/large_files": get: summary: Get large files - description: | + description: |- List files larger than 100MB found during the import - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files @@ -29321,14 +30078,15 @@ paths: "/repos/{owner}/{repo}/import/lfs": patch: summary: Update Git LFS preference - description: | + description: |- You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/repositories/working-with-files/managing-large-files). - **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + > [!WARNING] + > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference @@ -29637,10 +30395,8 @@ paths: description: |- List issues in a repository. Only open issues will be listed. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -30163,7 +30919,8 @@ paths: delete: summary: Delete an issue comment reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). tags: @@ -30272,10 +31029,8 @@ paths: access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -31248,7 +32003,8 @@ paths: delete: summary: Delete an issue reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). tags: @@ -33638,7 +34394,8 @@ paths: delete: summary: Delete a pull request comment reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: @@ -34230,8 +34987,8 @@ paths: description: |- Lists the files in a specified pull request. - **Note:** Responses include a maximum of 3000 files. The paginated response - returns 30 files per page by default. + > [!NOTE] + > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -34614,7 +35371,8 @@ paths: Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + > [!NOTE] + > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. @@ -34924,9 +35682,8 @@ paths: description: |- Dismisses a specified review on a pull request. - **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - you must be a repository administrator or be included in the list of people or teams - who can dismiss pull request reviews. + > [!NOTE] + > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -35625,9 +36382,8 @@ paths: description: |- Gets a public release with the specified release ID. - **Note:** This returns an `upload_url` key corresponding to the endpoint - for uploading release assets. This key is a hypermedia resource. For more information, see - "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + > [!NOTE] + > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release @@ -36006,7 +36762,8 @@ paths: delete: summary: Delete a release reaction description: |- - **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). tags: @@ -36142,7 +36899,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -36360,7 +37118,8 @@ paths: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -37057,7 +37816,8 @@ paths: description: |- Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. - **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + > [!NOTE] + > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. tags: - security-advisories operationId: security-advisories/create-fork @@ -37142,12 +37902,11 @@ paths: "/repos/{owner}/{repo}/stats/code_frequency": get: summary: Get the weekly commit activity - description: |2 - + description: |- Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - 10,000 or more commits, a 422 status code will be returned. + > [!NOTE] + > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. tags: - repos operationId: repos/get-code-frequency-stats @@ -37228,7 +37987,8 @@ paths: * `d` - Number of deletions * `c` - Number of commits - **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + > [!NOTE] + > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. tags: - repos operationId: repos/get-contributors-stats @@ -37599,8 +38359,8 @@ paths: get: summary: Deprecated - List tag protection states for a repository description: |- - **Note**: This operation is deprecated and will be removed after August 30th 2024 - Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + > [!WARNING] + > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. This returns the tag protection states of a repository. @@ -37641,8 +38401,8 @@ paths: post: summary: Deprecated - Create a tag protection state for a repository description: |- - **Note**: This operation is deprecated and will be removed after August 30th 2024 - Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + > [!WARNING] + > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. This creates a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -37698,8 +38458,8 @@ paths: delete: summary: Deprecated - Delete a tag protection state for a repository description: |- - **Note**: This operation is deprecated and will be removed after August 30th 2024 - Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + > [!WARNING] + > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. This deletes a tag protection state for a repository. This endpoint is only available to repository administrators. @@ -37735,7 +38495,9 @@ paths: Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. - **Note**: For private repositories, these links are temporary and expire after five minutes. + + > [!NOTE] + > For private repositories, these links are temporary and expire after five minutes. tags: - repos externalDocs: @@ -38164,7 +38926,8 @@ paths: `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. - **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + > [!NOTE] + > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. tags: - repos externalDocs: @@ -38277,7 +39040,7 @@ paths: type: string x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: repos subcategory: repos "/repositories": @@ -38515,7 +39278,8 @@ paths: This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + > [!NOTE] + > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." tags: - search operationId: search/issues-and-pull-requests @@ -38904,10 +39668,9 @@ paths: "/teams/{team_id}": get: summary: Get a team (Legacy) - description: "**Deprecation Notice:** This endpoint route is deprecated and - will be removed from the Teams API. We recommend migrating your existing code - to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) - endpoint." + description: |- + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy @@ -38939,11 +39702,13 @@ paths: patch: summary: Update a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. - **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + > [!NOTE] + > With nested teams, the `privacy` for parent teams cannot be `secret`. tags: - teams operationId: teams/update-legacy @@ -39045,7 +39810,8 @@ paths: delete: summary: Delete a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -39077,7 +39843,8 @@ paths: get: summary: List discussions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. List all discussions on a team's page. @@ -39119,7 +39886,8 @@ paths: post: summary: Create a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. Creates a new discussion post on a team's page. @@ -39185,7 +39953,8 @@ paths: get: summary: Get a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. Get a specific discussion on a team's page. @@ -39220,7 +39989,8 @@ paths: patch: summary: Update a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. @@ -39272,7 +40042,8 @@ paths: delete: summary: Delete a discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. Delete a discussion from a team's page. @@ -39301,7 +40072,8 @@ paths: get: summary: List discussion comments (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. List all comments on a team discussion. @@ -39344,7 +40116,8 @@ paths: post: summary: Create a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. Creates a new comment on a team discussion. @@ -39399,7 +40172,8 @@ paths: get: summary: Get a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. Get a specific comment on a team discussion. @@ -39435,7 +40209,8 @@ paths: patch: summary: Update a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. Edits the body text of a discussion comment. @@ -39487,7 +40262,8 @@ paths: delete: summary: Delete a discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. Deletes a comment on a team discussion. @@ -39517,7 +40293,8 @@ paths: get: summary: List reactions for a team discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -39576,7 +40353,8 @@ paths: post: summary: Create reaction for a team discussion comment (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). @@ -39641,7 +40419,8 @@ paths: get: summary: List reactions for a team discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -39699,7 +40478,8 @@ paths: post: summary: Create reaction for a team discussion (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). @@ -39763,7 +40543,8 @@ paths: get: summary: List pending team invitations (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. tags: @@ -39803,7 +40584,8 @@ paths: get: summary: List team members (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: @@ -39894,7 +40676,8 @@ paths: To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: @@ -39936,7 +40719,8 @@ paths: To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-member-legacy @@ -39963,7 +40747,8 @@ paths: get: summary: Get team membership for a user (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. @@ -40005,13 +40790,15 @@ paths: put: summary: Add or update team membership for a user (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. @@ -40072,13 +40859,15 @@ paths: delete: summary: Remove team membership for a user (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-membership-for-user-legacy @@ -40105,7 +40894,8 @@ paths: get: summary: List team projects (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. Lists the organization projects for a team. tags: @@ -40147,7 +40937,8 @@ paths: get: summary: Check team permissions for a project (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. tags: @@ -40182,7 +40973,8 @@ paths: put: summary: Add or update team project permissions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. tags: @@ -40252,7 +41044,8 @@ paths: delete: summary: Remove a project from a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. tags: @@ -40282,10 +41075,9 @@ paths: "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) - description: "**Deprecation Notice:** This endpoint route is deprecated and - will be removed from the Teams API. We recommend migrating your existing code - to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) - endpoint." + description: |- + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy @@ -40325,9 +41117,11 @@ paths: get: summary: Check team permissions for a repository (Legacy) description: |- - **Note**: Repositories inherited through a parent team will also be checked. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + > [!NOTE] + > Repositories inherited through a parent team will also be checked. You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: tags: @@ -40365,7 +41159,8 @@ paths: put: summary: Add or update team repository permissions (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. @@ -40420,7 +41215,8 @@ paths: delete: summary: Remove a repository from a team (Legacy) description: |- - **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: @@ -40447,10 +41243,9 @@ paths: "/teams/{team_id}/teams": get: summary: List child teams (Legacy) - description: "**Deprecation Notice:** This endpoint route is deprecated and - will be removed from the Teams API. We recommend migrating your existing code - to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) - endpoint." + description: |- + > [!WARNING] + > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy @@ -42633,10 +43428,8 @@ paths: description: |- List issues across owned and member repositories assigned to the authenticated user. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -44869,6 +45662,44 @@ paths: enabledForGitHubApps: false category: teams subcategory: teams + "/user/{account_id}": + get: + summary: Get a user using their ID + description: |- + Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-a-user-using-their-id + parameters: + - "$ref": "#/components/parameters/account-id" + responses: + '200': + description: Response + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/private-user" + - "$ref": "#/components/schemas/public-user" + examples: + default-response: + "$ref": "#/components/examples/public-user-default-response" + response-with-git-hub-plan-information: + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users "/users": get: summary: List users @@ -44947,6 +45778,71 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/users/{username}/attestations/{subject_digest}": + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/username" + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + "$ref": "#/components/schemas/sigstore-bundle-0" + repository_id: + type: integer + examples: + default: + value: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user @@ -44986,8 +45882,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -45018,8 +45917,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -45051,7 +45953,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -45763,9 +46667,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -45796,7 +46703,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user @@ -46532,7 +47441,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A check run was completed, and a conclusion is available. operationId: check-run/completed externalDocs: @@ -46612,7 +47522,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A new check run was created. operationId: check-run/created externalDocs: @@ -46692,7 +47603,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, @@ -46775,7 +47687,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. operationId: check-run/rerequested @@ -46856,7 +47769,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: All check runs in a check suite have completed, and a conclusion is available. operationId: check-suite/completed @@ -46927,7 +47841,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) @@ -47001,7 +47916,8 @@ x-webhooks: Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + > [!NOTE] + > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) @@ -47852,7 +48768,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - **Note**: This event will not occur when more than three tags are deleted at once. + > [!NOTE] + > This event will not occur when more than three tags are deleted at once. operationId: delete externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete @@ -47919,7 +48836,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed @@ -47988,7 +48906,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. @@ -48058,7 +48977,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. @@ -48128,7 +49048,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: @@ -48196,7 +49117,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: @@ -48264,7 +49186,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced @@ -48333,7 +49256,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + > [!NOTE] + > Webhook events for Dependabot alerts are currently in beta and subject to change. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: @@ -48915,7 +49839,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: @@ -48983,7 +49908,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: @@ -49051,7 +49977,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was closed. operationId: discussion/closed externalDocs: @@ -49119,7 +50046,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: @@ -49187,7 +50115,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: @@ -49255,7 +50184,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: @@ -49323,7 +50253,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was created. operationId: discussion/created externalDocs: @@ -49391,7 +50322,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was deleted. operationId: discussion/deleted externalDocs: @@ -49459,7 +50391,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: The title or body on a discussion was edited, or the category of the discussion was changed. operationId: discussion/edited @@ -49528,7 +50461,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A label was added to a discussion. operationId: discussion/labeled externalDocs: @@ -49596,7 +50530,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was locked. operationId: discussion/locked externalDocs: @@ -49664,7 +50599,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was pinned. operationId: discussion/pinned externalDocs: @@ -49732,7 +50668,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was reopened. operationId: discussion/reopened externalDocs: @@ -49800,7 +50737,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: @@ -49868,7 +50806,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: @@ -49936,7 +50875,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: @@ -50004,7 +50944,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: @@ -50072,7 +51013,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change. + > [!NOTE] + > Webhook events for GitHub Discussions are currently in beta and subject to change. description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: @@ -54124,7 +55066,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: @@ -54188,7 +55131,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled @@ -54253,7 +55197,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: @@ -54317,7 +55262,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + > [!NOTE] + > Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: @@ -55409,7 +56355,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: @@ -55476,7 +56423,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was created. operationId: projects-v2/created externalDocs: @@ -55543,7 +56491,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: @@ -55589,7 +56538,76 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: projects_v2 + supported-webhook-types: + - organization + projects-v2-edited: + post: + summary: |- + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The title, description, or README of a project in the organization + was changed. + operationId: projects-v2/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: project-v2 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55601,21 +56619,22 @@ x-webhooks: subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-edited: + projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The title, description, or README of a project in the organization - was changed. - operationId: projects-v2/edited + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An item on an organization project was archived. For more information, + see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -55629,7 +56648,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -55657,7 +56676,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55666,10 +56685,10 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-archived: + projects-v2-item-converted: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55678,10 +56697,10 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/archived + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A draft issue in an organization project was converted to an issue. + operationId: projects-v2-item/converted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55725,7 +56744,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55737,7 +56756,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-converted: + projects-v2-item-created: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55746,9 +56765,10 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A draft issue in an organization project was converted to an issue. - operationId: projects-v2-item/converted + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An item was added to a project in the organization. + operationId: projects-v2-item/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55792,7 +56812,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55804,7 +56824,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-created: + projects-v2-item-deleted: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55813,9 +56833,10 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was added to a project in the organization. - operationId: projects-v2-item/created + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An item was deleted from a project in the organization. + operationId: projects-v2-item/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55859,7 +56880,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55871,7 +56892,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-deleted: + projects-v2-item-edited: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55880,9 +56901,12 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was deleted from a project in the organization. - operationId: projects-v2-item/deleted + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The values or state of an item in an organization project were + changed. For example, the value of a field was updated, the body of a draft + issue was changed, or a draft issue was converted to an issue. + operationId: projects-v2-item/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55926,7 +56950,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55938,7 +56962,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-edited: + projects-v2-item-reordered: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -55947,11 +56971,12 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The values or state of an item in an organization project were - changed. For example, the value of a field was updated, the body of a draft - issue was changed, or a draft issue was converted to an issue. - operationId: projects-v2-item/edited + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: The position of an item in an organization project was changed. + For example, an item was moved above or below another item in the table or + board layout. + operationId: projects-v2-item/reordered externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -55995,7 +57020,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56007,7 +57032,7 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-reordered: + projects-v2-item-restored: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). @@ -56016,11 +57041,11 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The position of an item in an organization project was changed. - For example, an item was moved above or below another item in the table or - board layout. - operationId: projects-v2-item/reordered + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: An archived item on an organization project was restored from the + archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." + operationId: projects-v2-item/restored externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: @@ -56064,7 +57089,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56076,21 +57101,21 @@ x-webhooks: subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-item-restored: + projects-v2-reopened: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/restored + > [!NOTE] + > Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A project in the organization was reopened. + operationId: projects-v2/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -56104,7 +57129,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -56132,7 +57157,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56141,23 +57166,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-reopened: + projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was reopened. - operationId: projects-v2/reopened + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was added to a project in the organization. + operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -56171,7 +57197,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -56199,7 +57225,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56208,7 +57234,143 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_status_update + supported-webhook-types: + - organization + projects-v2-status-update-deleted: + post: + summary: |- + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + + For activity relating to a project, use the `projects_v2` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was removed from a project in the organization. + operationId: projects-v2-status-update/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: project-v2-status-update + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: projects_v2_status_update + supported-webhook-types: + - organization + projects-v2-status-update-edited: + post: + summary: |- + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + + For activity relating to a project, use the `projects_v2` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was edited on a project in the organization. + operationId: projects-v2-status-update/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: project-v2-status-update + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: webhooks + subcategory: projects_v2_status_update supported-webhook-types: - organization public: @@ -58211,7 +59373,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - **Note**: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. operationId: push externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#push @@ -58276,7 +59439,8 @@ x-webhooks: To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - **Note**: GitHub recommends that you use the newer `package` event instead. + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. description: A package was published to a registry. operationId: registry-package/published externalDocs: @@ -58342,7 +59506,8 @@ x-webhooks: To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - **Note**: GitHub recommends that you use the newer `package` event instead. + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: @@ -59896,7 +61061,8 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: @@ -59959,7 +61125,8 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: @@ -60022,7 +61189,8 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A previously dismissed or resolved repository vulnerability alert was reopened. operationId: repository-vulnerability-alert/reopen @@ -60086,7 +61254,8 @@ x-webhooks: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. - **Note**: This event is deprecated. Use the `dependabot_alert` event instead. + > [!WARNING] + > **Deprecation notice:** This event is deprecated. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: @@ -62511,6 +63680,7 @@ components: example: octocat id: type: integer + format: int64 example: 1 node_id: type: string @@ -62846,6 +64016,7 @@ components: example: octocat id: type: integer + format: int64 example: 1 node_id: type: string @@ -63883,6 +65054,7 @@ components: description: Unique identifier of the repository example: 42 type: integer + format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -64428,6 +65600,7 @@ components: properties: id: type: integer + format: int64 url: type: string format: uri @@ -65341,6 +66514,7 @@ components: properties: id: type: integer + format: int64 name: type: string slug: @@ -65785,6 +66959,7 @@ components: properties: id: type: integer + format: int64 example: 1296269 description: A unique identifier of the repository. node_id: @@ -66985,6 +68160,7 @@ components: type: string id: type: integer + format: int64 node_id: type: string avatar_url: @@ -67869,6 +69045,14 @@ components: enum: - enabled - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled minimal-repository: title: Minimal Repository description: Minimal Repository @@ -67876,6 +69060,7 @@ components: properties: id: type: integer + format: int64 example: 1296269 node_id: type: string @@ -68460,49 +69645,62 @@ components: type: boolean example: false description: |- + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean example: false description: |- - Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - this organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean example: false description: |- - Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - to this organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean example: false description: |- - Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean example: false description: |- - Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean example: false description: |- - Whether secret scanning push protection is automatically enabled for new repositories and repositories - transferred to this organization. + **Deprecated.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true secret_scanning_push_protection_custom_link_enabled: type: boolean example: false @@ -68657,7 +69855,8 @@ components: description: |- Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. - **Note**: The `patterns_allowed` setting only applies to public repositories. + > [!NOTE] + > The `patterns_allowed` setting only applies to public repositories. items: type: string actions-default-workflow-permissions: @@ -68954,7 +70153,6 @@ components: or closing the alert." nullable: true enum: - - - false positive - won't fix - used in tests @@ -68973,12 +70171,6 @@ components: name: type: string description: The name of the rule used to detect the alert. - tags: - nullable: true - type: array - description: A set of tags applicable for the rule. - items: - type: string severity: nullable: true type: string @@ -69000,6 +70192,12 @@ components: description: type: string description: A short description of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string code-scanning-analysis-tool-version: nullable: true type: string @@ -69136,6 +70334,143 @@ components: - tool - most_recent_instance - repository + code-security-configuration: + type: object + description: A code security configuration + properties: + id: + type: integer + description: The ID of the code security configuration + name: + type: string + description: The name of the code security configuration. Must be unique + within the organization. + target_type: + type: string + description: The type of the code security configuration. + enum: + - global + - organization + description: + type: string + description: A description of the code security configuration + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + url: + type: string + format: uri + description: The URL of the configuration + html_url: + type: string + format: uri + description: The URL of the configuration + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + code-security-default-configurations: + type: array + description: A list of default code security configurations + items: + type: object + properties: + default_for_new_repos: + enum: + - public + - private_and_internal + - all + description: The visibility of newly created repositories for which the + code security configuration will be applied to by default + configuration: + "$ref": "#/components/schemas/code-security-configuration" + code-security-configuration-repositories: + type: object + description: Repositories associated with a code security configuration and + attachment status + properties: + status: + type: string + description: The attachment status of the code security configuration on + the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + repository: + "$ref": "#/components/schemas/simple-repository" nullable-codespace-machine: type: object title: Codespace machine @@ -69196,6 +70531,7 @@ components: properties: id: type: integer + format: int64 example: 1 name: description: Automatically generated name of this codespace. @@ -69609,6 +70945,7 @@ components: properties: id: type: integer + format: int64 example: 1296269 node_id: type: string @@ -69998,6 +71335,7 @@ components: properties: id: type: integer + format: int64 login: type: string nullable: true @@ -70208,6 +71546,7 @@ components: properties: id: type: integer + format: int64 example: 79 owner: "$ref": "#/components/schemas/nullable-simple-user" @@ -70281,18 +71620,6 @@ components: - url - created_at - updated_at - organization-fine-grained-permission: - title: Organization Fine-Grained Permission - description: A fine-grained permission that protects organization resources. - type: object - properties: - name: - type: string - description: - type: string - required: - - name - - description organization-role: title: Organization Role description: Organization roles @@ -70301,6 +71628,7 @@ components: id: description: The unique identifier of the role. type: integer + format: int64 name: description: The name of the role. type: string @@ -70968,6 +72296,7 @@ components: description: Unique identifier of the repository example: 42 type: integer + format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -71462,6 +72791,7 @@ components: properties: id: type: integer + format: int64 example: 1296269 node_id: type: string @@ -72039,6 +73369,13 @@ components: description: The values to match for the repository property items: type: string + source: + type: string + description: The source of the repository property. Defaults to 'custom' + if not specified. + enum: + - custom + - system required: - name - property_values @@ -72143,6 +73480,78 @@ components: type: string enum: - required_linear_history + repository-rule-merge-queue: + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check to report a conclusion. + After this much time has elapsed, checks that have not reported a + conclusion will be assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit created by merge + queue for each PR in the group must pass all required checks to merge. + When set to HEADGREEN, only the commit at the head of the merge group, + i.e. the commit containing changes from all of the PRs in the group, + must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests requesting checks + and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after the first PR is + added to the queue for the minimum group size to be met. After this + time has elapsed, the minimum group size will be ignored and a smaller + group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes repository-rule-required-deployments: title: required_deployments description: Choose which environments must be successfully deployed to before @@ -72250,6 +73659,10 @@ components: parameters: type: object properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. required_status_checks: type: array description: Status checks that are required. @@ -72492,6 +73905,10 @@ components: parameters: type: object properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. workflows: type: array description: Workflows that must pass for this rule to pass. @@ -72566,6 +73983,7 @@ components: - "$ref": "#/components/schemas/repository-rule-update" - "$ref": "#/components/schemas/repository-rule-deletion" - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-merge-queue" - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-required-signatures" - "$ref": "#/components/schemas/repository-rule-pull-request" @@ -72578,7 +73996,8 @@ components: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - title: file_path_restriction description: |- - Note: file_path_restriction is in beta and subject to change. + > [!NOTE] + > `file_path_restriction` is in beta and subject to change. Prevent commits that include changes in specified file paths from being pushed to the commit graph. type: object @@ -72602,7 +74021,8 @@ components: - restricted_file_paths - title: max_file_path_length description: |- - Note: max_file_path_length is in beta and subject to change. + > [!NOTE] + > `max_file_path_length` is in beta and subject to change. Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. type: object @@ -72625,7 +74045,8 @@ components: - max_file_path_length - title: file_extension_restriction description: |- - Note: file_extension_restriction is in beta and subject to change. + > [!NOTE] + > `file_extension_restriction` is in beta and subject to change. Prevent commits that include files with specified file extensions from being pushed to the commit graph. type: object @@ -72649,7 +74070,8 @@ components: - restricted_file_extensions - title: max_file_size description: |- - Note: max_file_size is in beta and subject to change. + > [!NOTE] + > `max_file_size` is in beta and subject to change. Prevent commits that exceed a specified file size limit from being pushed to the commit. type: object @@ -72694,7 +74116,8 @@ components: description: |- The target of the ruleset - **Note**: The `push` target is in beta and is subject to change. + > [!NOTE] + > The `push` target is in beta and is subject to change. enum: - branch - tag @@ -74304,6 +75727,7 @@ components: description: The project card's ID example: 42 type: integer + format: int64 node_id: type: string example: MDExOlByb2plY3RDYXJkMTQ3OA== @@ -74879,6 +76303,7 @@ components: properties: id: type: integer + format: int64 number: type: integer url: @@ -74895,6 +76320,7 @@ components: properties: id: type: integer + format: int64 url: type: string name: @@ -74919,6 +76345,7 @@ components: properties: id: type: integer + format: int64 url: type: string name: @@ -75280,8 +76707,9 @@ components: properties: id: description: The id of the environment. - example: 56780428 type: integer + format: int64 + example: 56780428 node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= @@ -75341,8 +76769,9 @@ components: example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment - example: 42 type: integer + format: int64 + example: 42 node_id: type: string example: MDEwOkRlcGxveW1lbnQx @@ -75822,6 +77251,7 @@ components: type: string id: type: integer + format: int64 node_id: type: string avatar_url: @@ -76256,9 +77686,15 @@ components: - tree - url author: - "$ref": "#/components/schemas/nullable-simple-user" + nullable: true + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" committer: - "$ref": "#/components/schemas/nullable-simple-user" + nullable: true + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" parents: type: array items: @@ -77800,6 +79236,7 @@ components: example: octocat id: type: integer + format: int64 example: 1 email: nullable: true @@ -77912,6 +79349,7 @@ components: description: Unique identifier of the repository invitation. example: 42 type: integer + format: int64 repository: "$ref": "#/components/schemas/minimal-repository" invitee: @@ -77964,6 +79402,7 @@ components: example: octocat id: type: integer + format: int64 example: 1 email: nullable: true @@ -78207,6 +79646,7 @@ components: example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer + format: int64 example: 1 node_id: type: string @@ -79558,6 +80998,11 @@ components: example: NOASSERTION description: The distribution source of this package, or NOASSERTION if this was not determined. + copyrightText: + type: string + example: Copyright (c) 1985 GitHub.com + description: The copyright holders of the package, and any dates + present with those notices, if available. externalRefs: type: array items: @@ -79775,6 +81220,7 @@ components: example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: type: integer + format: int64 example: 1 node_id: type: string @@ -79887,6 +81333,7 @@ components: description: The id of the environment. example: 56780428 type: integer + format: int64 node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= @@ -81744,6 +83191,7 @@ components: type: object properties: id: + description: Unique identifier for the label. type: integer format: int64 example: 208045946 @@ -81760,6 +83208,7 @@ components: example: bug type: string description: + description: Optional description of the label, such as its purpose. type: string example: Something isn't working nullable: true @@ -81769,6 +83218,7 @@ components: example: FFFFFF type: string default: + description: Whether this label comes by default in a new repository. type: boolean example: true required: @@ -82083,13 +83533,15 @@ components: type: string pull_request_review_id: description: The ID of the pull request review to which the comment belongs. - example: 42 type: integer + format: int64 + example: 42 nullable: true id: description: The ID of the pull request review comment. - example: 1 type: integer + format: int64 + example: 1 node_id: description: The node ID of the pull request review comment. type: string @@ -83032,6 +84484,7 @@ components: example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer + format: int64 example: 1 node_id: type: string @@ -83579,6 +85032,7 @@ components: format: uri id: type: integer + format: int64 node_id: type: string login: @@ -84017,6 +85471,7 @@ components: format: uri id: type: integer + format: int64 node_id: type: string login: @@ -84223,6 +85678,7 @@ components: description: Unique identifier of the review example: 42 type: integer + format: int64 node_id: type: string example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -84301,10 +85757,12 @@ components: example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: type: integer + format: int64 example: 42 nullable: true id: type: integer + format: int64 example: 10 node_id: type: string @@ -84628,6 +86086,9 @@ components: - allOf: - "$ref": "#/components/schemas/repository-rule-required-linear-history" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-merge-queue" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -86351,6 +87812,7 @@ components: type: string id: type: integer + format: int64 node_id: type: string avatar_url: @@ -86466,6 +87928,7 @@ components: example: octocat id: type: integer + format: int64 example: 1 node_id: type: string @@ -86762,6 +88225,7 @@ components: properties: id: type: integer + format: int64 example: 1 name: description: Automatically generated name of this codespace. @@ -86998,6 +88462,7 @@ components: properties: id: type: integer + format: int64 example: 3 name: type: string @@ -87044,6 +88509,7 @@ components: properties: id: type: integer + format: int64 primary_key_id: type: integer key_id: @@ -87128,6 +88594,7 @@ components: type: string id: type: integer + format: int64 url: type: string title: @@ -87263,6 +88730,76 @@ components: required: - starred_at - repo + sigstore-bundle-0: + title: Sigstore Bundle v0.1 + description: Sigstore Bundle v0.1 + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: + x509CertificateChain: + type: object + properties: + certificates: + type: array + items: + type: object + properties: + rawBytes: + type: string + tlogEntries: + type: array + items: + type: object + properties: + logIndex: + type: string + logId: + type: object + properties: + keyId: + type: string + kindVersion: + type: object + properties: + kind: + type: string + version: + type: string + integratedTime: + type: string + inclusionPromise: + type: object + properties: + signedEntryTimestamp: + type: string + inclusionProof: + type: string + nullable: true + canonicalizedBody: + type: string + timestampVerificationData: + type: string + nullable: true + dsseEnvelope: + type: object + properties: + payload: + type: string + payloadType: + type: string + signatures: + type: array + items: + type: object + properties: + sig: + type: string + keyid: + type: string hovercard: title: Hovercard description: Hovercard @@ -87296,7 +88833,7 @@ components: - id enterprise-webhooks: title: Enterprise - description: | + description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." @@ -87442,6 +88979,7 @@ components: description: Unique identifier of the repository example: 42 type: integer + format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -88322,6 +89860,20 @@ components: - 'off' - non_admins - everyone + lock_branch_enforcement_level: + description: The enforcement level of the branch lock setting. `off` means + the branch is not locked, `non_admins` means the branch is read-only for + non_admins, and `everyone` means the branch is read-only for everyone. + type: string + enum: + - 'off' + - non_admins + - everyone + lock_allows_fork_sync: + description: Whether users can pull changes from upstream when the branch + is locked. Set to `true` to allow users to pull changes from upstream + when the branch is locked. This setting is only applicable for forks. + type: boolean merge_queue_enforcement_level: type: string enum: @@ -88396,6 +89948,7 @@ components: - strict_required_status_checks_policy - signature_requirement_enforcement_level - linear_history_requirement_enforcement_level + - lock_branch_enforcement_level - admin_enforced - allow_force_pushes_enforcement_level - allow_deletions_enforcement_level @@ -88854,6 +90407,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -88995,6 +90549,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -89287,6 +90842,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -89322,6 +90878,10 @@ components: required: - login - id + labels: + type: array + items: + "$ref": "#/components/schemas/label" required: - repository_url - category @@ -89448,6 +91008,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -89700,6 +91261,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -90595,6 +92157,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -91617,6 +93180,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -92056,6 +93620,7 @@ components: description: Unique identifier of the repository example: 42 type: integer + format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -92976,6 +94541,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -93581,6 +95147,54 @@ components: required: - id - title + projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at webhooks_number: description: The pull request number. type: integer @@ -94144,6 +95758,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -94535,6 +96150,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -94761,6 +96377,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -95152,6 +96769,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -95798,6 +97416,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -96085,6 +97704,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -96243,6 +97863,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -97732,6 +99353,44 @@ components: - everyone required: - from + lock_branch_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + lock_allows_fork_sync: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + pull_request_reviews_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + require_last_push_approval: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from required_status_checks: type: object properties: @@ -101186,6 +102845,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -101310,7 +102970,6 @@ components: required: - action - definition - - organization webhook-custom-property-deleted: title: custom property deleted event type: object @@ -101338,7 +102997,6 @@ components: required: - action - definition - - organization webhook-custom-property-updated: title: custom property updated event type: object @@ -101360,7 +103018,6 @@ components: required: - action - definition - - organization webhook-custom-property-values-updated: title: Custom property values updated event type: object @@ -107166,6 +108823,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -108239,6 +109897,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -109130,6 +110789,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -109392,6 +111052,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -110278,6 +111939,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -110540,6 +112202,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -111431,6 +113094,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -111693,6 +113357,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -112611,6 +114276,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -112778,6 +114444,7 @@ components: type: string id: type: integer + format: int64 login: type: string node_id: @@ -113653,6 +115320,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -114591,6 +116259,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -115504,6 +117173,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -116422,6 +118092,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -117364,6 +119035,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -118276,6 +119948,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -119163,6 +120836,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -119373,6 +121047,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -120519,6 +122194,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -121485,6 +123161,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -122369,6 +124046,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -122580,6 +124258,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -123833,6 +125512,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -127777,6 +129457,124 @@ components: - projects_v2 - organization - sender + webhook-projects-v2-status-update-created: + title: Projects v2 Status Update Created Event + type: object + properties: + action: + type: string + enum: + - created + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + projects_v2_status_update: + "$ref": "#/components/schemas/projects-v2-status-update" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - projects_v2_status_update + - organization + - sender + webhook-projects-v2-status-update-deleted: + title: Projects v2 Status Update Deleted Event + type: object + properties: + action: + type: string + enum: + - deleted + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + projects_v2_status_update: + "$ref": "#/components/schemas/projects-v2-status-update" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - projects_v2_status_update + - organization + - sender + webhook-projects-v2-status-update-edited: + title: Projects v2 Status Update Edited Event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + type: string + nullable: true + to: + type: string + nullable: true + status: + type: object + properties: + from: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + to: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: object + properties: + from: + type: string + format: date + nullable: true + to: + type: string + format: date + nullable: true + target_date: + type: object + properties: + from: + type: string + format: date + nullable: true + to: + type: string + format: date + nullable: true + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + projects_v2_status_update: + "$ref": "#/components/schemas/projects-v2-status-update" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - projects_v2_status_update + - organization + - sender webhook-public: title: public event type: object @@ -128310,6 +130108,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -128702,6 +130501,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -128930,6 +130730,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -129322,6 +131123,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -129979,6 +131781,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -130575,6 +132378,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -130967,6 +132771,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -131193,6 +132998,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -131585,6 +133391,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -132241,6 +134048,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -132839,6 +134647,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -133231,6 +135040,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -133849,6 +135659,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -134506,6 +136317,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -135186,6 +136998,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -135578,6 +137391,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -135804,6 +137618,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -136196,6 +138011,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -136843,6 +138659,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -137511,6 +139328,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -137903,6 +139721,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -138129,6 +139948,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -138521,6 +140341,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -139168,6 +140989,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -139767,6 +141589,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -140159,6 +141982,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -140387,6 +142211,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -140779,6 +142604,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -141437,6 +143263,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -142033,6 +143860,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -142425,6 +144253,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -142653,6 +144482,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -143045,6 +144875,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -143702,6 +145533,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -144123,6 +145955,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -144685,6 +146518,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -145077,6 +146911,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -145293,6 +147128,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -145684,6 +147520,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -146252,6 +148089,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -146842,6 +148680,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -147234,6 +149073,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -147450,6 +149290,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -147842,6 +149683,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -148399,6 +150241,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -148991,6 +150834,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -149383,6 +151227,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -149599,6 +151444,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -149991,6 +151837,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -150549,6 +152396,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -151141,6 +152989,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -151533,6 +153382,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -151749,6 +153599,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -152141,6 +153992,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -152708,6 +154560,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -152883,6 +154736,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -153457,6 +155311,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -153794,6 +155649,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -154006,6 +155862,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -154343,6 +156200,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -154911,6 +156769,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -155511,6 +157370,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -155894,6 +157754,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -156120,6 +157981,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -156512,6 +158374,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -157177,6 +159040,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -157838,6 +159702,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -158230,6 +160095,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -158456,6 +160322,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -158848,6 +160715,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -159513,6 +161381,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -160220,6 +162089,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -160612,6 +162482,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -160838,6 +162709,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -161230,6 +163102,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -161887,6 +163760,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -162552,6 +164426,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -162944,6 +164819,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -163170,6 +165046,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -163562,6 +165439,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -164210,6 +166088,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -164903,6 +166782,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -165295,6 +167175,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -165512,6 +167393,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -165904,6 +167786,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -166472,6 +168355,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -167065,6 +168949,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -167407,6 +169292,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -167624,6 +169510,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -167966,6 +169853,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -168533,6 +170421,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -168836,6 +170725,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -169415,6 +171305,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -169757,6 +171648,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -169972,6 +171864,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -170314,6 +172207,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -170871,6 +172765,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -171172,6 +173067,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -171761,6 +173657,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -172153,6 +174050,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -172379,6 +174277,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -172762,6 +174661,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -173419,6 +175319,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -174021,6 +175922,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -174413,6 +176315,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -174641,6 +176544,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -175033,6 +176937,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -175691,6 +177596,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -176289,6 +178195,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -176681,6 +178588,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -176909,6 +178817,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -177292,6 +179201,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -177949,6 +179859,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -178543,6 +180454,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -178935,6 +180847,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -179162,6 +181075,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -179554,6 +181468,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -180200,6 +182115,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -180678,6 +182594,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -182973,6 +184890,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -184521,6 +186439,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -184996,6 +186915,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -185472,6 +187392,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -186012,6 +187933,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -186489,6 +188411,7 @@ components: id: description: Unique identifier of the repository type: integer + format: int64 is_template: type: boolean issue_comment_url: @@ -195793,6 +197716,97 @@ components: updated_at: '2020-01-10T14:59:22Z' visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 simple-user-items: value: - login: octocat @@ -196041,6 +198055,192 @@ components: teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + code-security-configuration-list: + value: + - id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: organization + name: High risk settings + description: This is a code security configuration for octo-org high risk + repositories + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + code-security-configuration: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-default-configurations: + value: + - default_for_new_repos: public + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + - default_for_new_repos: private_and_internal + configuration: + id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + code-security-configuration-updated: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings v2 + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: disabled + secret_scanning_push_protection: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: disabled + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + simple-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks codespaces-list: value: total_count: 3 @@ -197687,12 +199887,8 @@ components: status: enabled secret_scanning_push_protection: status: disabled - organization-fine-grained-permission-example: - value: - - name: read_organization_custom_org_role - description: View organization roles - - name: write_organization_custom_org_role - description: Manage custom organization roles + secret_scanning_non_provider_patterns: + status: disabled organization-role-list: value: total_count: 2 @@ -200303,6 +202499,8 @@ components: status: enabled secret_scanning_push_protection: status: disabled + secret_scanning_non_provider_patterns: + status: disabled artifact-paginated: value: total_count: 2 @@ -201246,6 +203444,51 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + attestation: + value: + bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== autolink-items: value: - id: 1 @@ -205884,6 +208127,7 @@ components: filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT + copyrightText: Copyright (c) 1985 GitHub.com dependency-graph-create-snapshot-request: value: version: 0 @@ -217071,6 +219315,13 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + configuration-id: + name: configuration_id + description: The unique identifier of the code security configuration. + in: path + required: true + schema: + type: integer hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the @@ -217239,6 +219490,18 @@ components: required: true schema: type: string + ref-in-query: + name: ref + description: 'The name of the ref. Cannot contain wildcard characters. Optionally + prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to + tags. Omit the prefix to search across all refs. When specified, only rule + evaluations triggered for this ref will be returned. + + ' + in: query + schema: + type: string + x-multi-segment: true repository-name-in-query: name: repository_name description: The name of the repository to filter on. When specified, only rule @@ -217769,14 +220032,6 @@ components: required: true schema: type: integer - ref-in-query: - name: ref - description: The name of the ref. Cannot contain wildcard characters. When specified, - only rule evaluations triggered for this ref will be returned. - in: query - schema: - type: string - x-multi-segment: true tag-protection-id: name: tag_protection_id description: The unique identifier of the tag protection. @@ -218041,11 +220296,11 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" + no_content: + description: A header with no content is returned. package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - no_content: - description: A header with no content is returned. gone: description: Gone content: diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index bcceed1ea..e1f03ff19 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -1014,7 +1014,8 @@ export interface paths { /** @description

Retrieves a Session object.

*/ get: operations["GetCheckoutSessionsSession"]; put?: never; - post?: never; + /** @description

Updates a Session object.

*/ + post: operations["PostCheckoutSessionsSession"]; delete?: never; options?: never; head?: never; @@ -1399,7 +1400,7 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

*/ + /** @description

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

*/ post: operations["PostCustomerSessions"]; delete?: never; options?: never; @@ -2073,7 +2074,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

*/ + /** @description

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

*/ get: operations["GetEventsId"]; put?: never; post?: never; @@ -2710,6 +2711,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoices/{invoice}/add_lines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

*/ + post: operations["PostInvoicesInvoiceAddLines"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoices/{invoice}/finalize": { parameters: { query?: never; @@ -2798,6 +2816,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoices/{invoice}/remove_lines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

*/ + post: operations["PostInvoicesInvoiceRemoveLines"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoices/{invoice}/send": { parameters: { query?: never; @@ -2817,6 +2852,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoices/{invoice}/update_lines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

*/ + post: operations["PostInvoicesInvoiceUpdateLines"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoices/{invoice}/void": { parameters: { query?: never; @@ -4344,7 +4396,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

*/ + /** @description

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

*/ get: operations["GetRefunds"]; put?: never; /** @description

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

@@ -5030,7 +5082,7 @@ export interface paths { put?: never; /** @description

Updates an existing subscription to match the specified parameters. * When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. - * To preview how the proration is calculated, use the upcoming invoice endpoint.

+ * To preview how the proration is calculated, use the create preview endpoint.

* *

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

* @@ -5038,11 +5090,11 @@ export interface paths { * *
    *
  • The billing interval is changed (for example, from monthly to yearly).
    • - *
  • The subscription moves from free to paid, or paid to free.
    • + *
  • The subscription moves from free to paid.
    • *
  • A trial starts or ends.
    • *
* - *

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

+ *

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

* *

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

* @@ -5104,7 +5156,7 @@ export interface paths { }; get?: never; put?: never; - /** @description

Calculates tax based on input and returns a Tax Calculation object.

*/ + /** @description

Calculates tax based on the input and returns a Tax Calculation object.

*/ post: operations["PostTaxCalculations"]; delete?: never; options?: never; @@ -5658,6 +5710,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

*/ + post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { parameters: { query?: never; @@ -6859,7 +6928,7 @@ export interface components { individual?: components["schemas"]["person"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -6880,7 +6949,7 @@ export interface components { }; /** AccountAnnualRevenue */ account_annual_revenue: { - /** @description A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ + /** @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). */ amount?: number | null; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency?: string | null; @@ -6911,7 +6980,7 @@ export interface components { annual_revenue?: components["schemas"]["account_annual_revenue"] | null; /** @description An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. */ estimated_worker_count?: number | null; - /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ + /** @description [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ mcc?: string | null; monthly_estimated_revenue?: components["schemas"]["account_monthly_estimated_revenue"]; /** @description The customer-facing business name. */ @@ -7178,8 +7247,11 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due: string[]; - /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ - disabled_reason?: string | null; + /** + * @description This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. + * @enum {string|null} + */ + disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ @@ -7200,12 +7272,11 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ currently_due: string[]; - /** @description If the capability is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.other`, `platform_paused`, `rejected.inactivty`, or `rejected.unsupported_business`. - * - * `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses). - * - * `rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details. */ - disabled_reason?: string | null; + /** + * @description Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). + * @enum {string|null} + */ + disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ @@ -7298,7 +7369,7 @@ export interface components { }; /** AccountMonthlyEstimatedRevenue */ account_monthly_estimated_revenue: { - /** @description A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ + /** @description A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). */ amount: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; @@ -7829,7 +7900,7 @@ export interface components { last4: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -7866,13 +7937,13 @@ export interface components { as_of: number; cash?: components["schemas"]["bank_connections_resource_balance_api_resource_cash_balance"]; credit?: components["schemas"]["bank_connections_resource_balance_api_resource_credit_balance"]; - /** @description The balances owed to (or by) the account holder. + /** @description The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions. * * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. * * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */ current: { - [key: string]: number | undefined; + [key: string]: number; }; /** * @description The `type` of the balance. An additional hash is included on the balance with a name matching this value. @@ -7882,13 +7953,13 @@ export interface components { }; /** BankConnectionsResourceBalanceAPIResourceCashBalance */ bank_connections_resource_balance_api_resource_cash_balance: { - /** @description The funds available to the account holder. Typically this is the current balance less any holds. + /** @description The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions. * * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. * * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */ available?: { - [key: string]: number | undefined; + [key: string]: number; } | null; }; /** BankConnectionsResourceBalanceAPIResourceCreditBalance */ @@ -7899,7 +7970,7 @@ export interface components { * * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */ used?: { - [key: string]: number | undefined; + [key: string]: number; } | null; }; /** BankConnectionsResourceBalanceRefresh */ @@ -7922,6 +7993,8 @@ export interface components { }; /** BankConnectionsResourceLinkAccountSessionFilters */ bank_connections_resource_link_account_session_filters: { + /** @description Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`. */ + account_subcategories?: ("checking" | "credit_card" | "line_of_credit" | "mortgage" | "savings")[] | null; /** @description List of countries from which to filter accounts. */ countries?: string[] | null; }; @@ -8043,7 +8116,7 @@ export interface components { object: "billing.meter_event"; /** @description The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ payload: { - [key: string]: string | undefined; + [key: string]: string; }; /** * Format: unix-time @@ -8088,7 +8161,7 @@ export interface components { aggregated_value: number; /** * Format: unix-time - * @description End timestamp for this event summary (inclusive). + * @description End timestamp for this event summary (exclusive). Must be aligned with minute boundaries. */ end_time: number; /** @description Unique identifier for the object. */ @@ -8104,7 +8177,7 @@ export interface components { object: "billing.meter_event_summary"; /** * Format: unix-time - * @description Start timestamp for this event summary (inclusive). + * @description Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries. */ start_time: number; }; @@ -8182,7 +8255,7 @@ export interface components { login_page: components["schemas"]["portal_login_page"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -8210,7 +8283,7 @@ export interface components { * Create sessions on-demand when customers intend to manage their subscriptions * and billing details. * - * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). + * Related guide: [Customer management](/customer-management) */ "billing_portal.session": { /** @description The configuration used by this session, describing the features available. */ @@ -8350,7 +8423,7 @@ export interface components { last4: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description Cardholder name. */ name?: string | null; @@ -8389,7 +8462,7 @@ export interface components { cash_balance: { /** @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ available?: { - [key: string]: number | undefined; + [key: string]: number; } | null; /** @description The ID of the customer whose cash balance this object represents. */ customer: string; @@ -8425,7 +8498,7 @@ export interface components { /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; billing_details: components["schemas"]["billing_details"]; - /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. */ + /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This only works for card payments. */ calculated_statement_descriptor?: string | null; /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ captured: boolean; @@ -8458,7 +8531,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -8607,7 +8680,7 @@ export interface components { created: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency?: string | null; - /** @description Currency conversion details for automatic currency conversion sessions */ + /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields: components["schemas"]["payment_pages_checkout_session_custom_fields"][]; @@ -8668,7 +8741,7 @@ export interface components { locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-GB" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW" | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description The mode of the Checkout Session. @@ -8785,6 +8858,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8802,6 +8877,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8814,6 +8891,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8826,6 +8905,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8838,6 +8919,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8850,6 +8933,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8862,6 +8947,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8874,6 +8961,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8888,6 +8977,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8911,6 +9002,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8927,6 +9020,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8958,6 +9053,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8970,6 +9067,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8982,6 +9081,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -8994,6 +9095,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9006,6 +9109,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9018,6 +9123,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9030,6 +9137,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9044,6 +9153,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9056,6 +9167,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9068,6 +9181,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9080,6 +9195,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9094,6 +9211,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9106,6 +9225,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9118,6 +9239,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9139,6 +9262,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9156,6 +9281,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9168,6 +9295,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9215,6 +9344,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9233,6 +9364,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -9300,7 +9433,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * Format: decimal @@ -9338,7 +9471,7 @@ export interface components { created: number; /** @description Current prices for a metric ton of carbon removal in a currency's smallest unit. */ current_prices_per_metric_ton: { - [key: string]: components["schemas"]["climate_removals_products_price"] | undefined; + [key: string]: components["schemas"]["climate_removals_products_price"]; }; /** @description The year in which the carbon removal is expected to be delivered. */ delivery_year?: number | null; @@ -9468,6 +9601,8 @@ export interface components { object: "confirmation_token"; /** @description ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ payment_intent?: string | null; + /** @description Payment-method-specific configuration for this ConfirmationToken. */ + payment_method_options?: components["schemas"]["confirmation_tokens_resource_payment_method_options"] | null; /** @description Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. */ payment_method_preview?: components["schemas"]["confirmation_tokens_resource_payment_method_preview"] | null; /** @description Return URL used to confirm the Intent. */ @@ -9513,6 +9648,22 @@ export interface components { /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ user_agent?: string | null; }; + /** + * ConfirmationTokensResourcePaymentMethodOptions + * @description Payment-method-specific configuration + */ + confirmation_tokens_resource_payment_method_options: { + /** @description This hash contains the card payment method options. */ + card?: components["schemas"]["confirmation_tokens_resource_payment_method_options_resource_card"] | null; + }; + /** + * ConfirmationTokensResourcePaymentMethodOptionsResourceCard + * @description This hash contains the card payment method options. + */ + confirmation_tokens_resource_payment_method_options_resource_card: { + /** @description The `cvc_update` Token collected from the Payment Element. */ + cvc_token?: string | null; + }; /** * ConfirmationTokensResourcePaymentMethodPreview * @description Details of the PaymentMethod collected by Payment Element @@ -9537,6 +9688,8 @@ export interface components { card?: components["schemas"]["payment_method_card"]; card_present?: components["schemas"]["payment_method_card_present"]; cashapp?: components["schemas"]["payment_method_cashapp"]; + /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + customer?: (string | components["schemas"]["customer"]) | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; fpx?: components["schemas"]["payment_method_fpx"]; @@ -9627,6 +9780,8 @@ export interface components { payments: components["schemas"]["connect_embedded_payments_config_claim"]; payouts: components["schemas"]["connect_embedded_payouts_config_claim"]; payouts_list: components["schemas"]["connect_embedded_base_config_claim"]; + tax_registrations: components["schemas"]["connect_embedded_base_config_claim"]; + tax_settings: components["schemas"]["connect_embedded_base_config_claim"]; }; /** ConnectEmbeddedBaseConfigClaim */ connect_embedded_base_config_claim: { @@ -9691,7 +9846,7 @@ export interface components { object: "country_spec"; /** @description Currencies that can be accepted in the specific country (for transfers). */ supported_bank_account_currencies: { - [key: string]: string[] | undefined; + [key: string]: string[]; }; /** @description Currencies that can be accepted in the specified country (for payments). */ supported_payment_currencies: string[]; @@ -9732,7 +9887,7 @@ export interface components { currency?: string | null; /** @description Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { - [key: string]: components["schemas"]["coupon_currency_option"] | undefined; + [key: string]: components["schemas"]["coupon_currency_option"]; }; /** * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. @@ -9749,7 +9904,7 @@ export interface components { max_redemptions?: number | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description Name of the coupon displayed to customers on for instance invoices or receipts. */ name?: string | null; @@ -9838,7 +9993,7 @@ export interface components { memo?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ number: string; @@ -10020,7 +10175,7 @@ export interface components { id: string; /** @description The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. */ invoice_credit_balance?: { - [key: string]: number | undefined; + [key: string]: number; }; /** @description The prefix for the customer used to generate unique invoice numbers. */ invoice_prefix?: string | null; @@ -10029,11 +10184,11 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The customer's full name or business name. */ name?: string | null; - /** @description The suffix of the customer's next invoice number (for example, 0001). */ + /** @description The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. */ next_invoice_sequence?: number; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -10248,7 +10403,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -10305,11 +10460,11 @@ export interface components { }; /** * CustomerSessionResourceCustomerSession - * @description A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs) - * control over a customer. + * @description A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access + * control over a Customer. */ customer_session: { - /** @description The client secret of this customer session. Used on the client to set up secure access to the given `customer`. + /** @description The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`. * * The client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret. */ client_secret: string; @@ -10319,11 +10474,11 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The customer the customer session was created for. */ + /** @description The Customer the Customer Session was created for. */ customer: string | components["schemas"]["customer"]; /** * Format: unix-time - * @description The timestamp at which this customer session will expire. + * @description The timestamp at which this Customer Session will expire. */ expires_at: number; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -10336,10 +10491,11 @@ export interface components { }; /** * CustomerSessionResourceComponents - * @description Configuration for the components supported by this customer session. + * @description Configuration for the components supported by this Customer Session. */ customer_session_resource_components: { buy_button: components["schemas"]["customer_session_resource_components_resource_buy_button"]; + payment_element: components["schemas"]["customer_session_resource_components_resource_payment_element"]; pricing_table: components["schemas"]["customer_session_resource_components_resource_pricing_table"]; }; /** @@ -10350,6 +10506,54 @@ export interface components { /** @description Whether the buy button is enabled. */ enabled: boolean; }; + /** + * CustomerSessionResourceComponentsResourcePaymentElement + * @description This hash contains whether the Payment Element is enabled and the features it supports. + */ + customer_session_resource_components_resource_payment_element: { + /** @description Whether the Payment Element is enabled. */ + enabled: boolean; + /** @description This hash defines whether the Payment Element supports certain features. */ + features?: components["schemas"]["customer_session_resource_components_resource_payment_element_resource_features"] | null; + }; + /** + * CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures + * @description This hash contains the features the Payment Element supports. + */ + customer_session_resource_components_resource_payment_element_resource_features: { + /** @description A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list. + * + * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"]. */ + payment_method_allow_redisplay_filters: ("always" | "limited" | "unspecified")[]; + /** + * @description Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`. + * @enum {string} + */ + payment_method_redisplay: "disabled" | "enabled"; + /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `10`. */ + payment_method_redisplay_limit?: number | null; + /** + * @description Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`. + * + * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods). + * @enum {string} + */ + payment_method_remove: "disabled" | "enabled"; + /** + * @description Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`. + * + * If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`. + * @enum {string} + */ + payment_method_save: "disabled" | "enabled"; + /** + * @description When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent. + * + * When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation. + * @enum {string|null} + */ + payment_method_save_usage?: "off_session" | "on_session" | null; + }; /** * CustomerSessionResourceComponentsResourcePricingTable * @description This hash contains whether the pricing table is enabled. @@ -10863,7 +11067,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -10967,6 +11171,11 @@ export interface components { dispute_payment_method_details_card: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand: string; + /** + * @description The type of dispute opened. Different case types may have varying fees and financial impact. + * @enum {string} + */ + case_type: "chargeback" | "inquiry"; /** @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. */ network_reason_code?: string | null; }; @@ -11027,7 +11236,7 @@ export interface components { lookup_key: string; /** @description Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The feature's name, for your own purpose, not meant to be displayable to the customer. */ name: string; @@ -11164,7 +11373,7 @@ export interface components { object: "exchange_rate"; /** @description Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency. */ rates: { - [key: string]: number | undefined; + [key: string]: number; }; }; /** Polymorphic */ @@ -11219,7 +11428,7 @@ export interface components { id: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -11315,7 +11524,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -12122,7 +12331,7 @@ export interface components { * API. To configure and create VerificationReports, use the * [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API. * - * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). + * Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ "identity.verification_report": { /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ @@ -12191,7 +12400,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -12441,7 +12650,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * Format: unix-time @@ -12638,11 +12847,17 @@ export interface components { }; /** invoice_payment_method_options_us_bank_account_linked_account_options */ invoice_payment_method_options_us_bank_account_linked_account_options: { + filters?: components["schemas"]["invoice_payment_method_options_us_bank_account_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description Data features requested to be retrieved upon account creation. */ prefetch?: ("balances" | "ownership" | "transactions")[] | null; }; + /** invoice_payment_method_options_us_bank_account_linked_account_options_filters */ + invoice_payment_method_options_us_bank_account_linked_account_options_filters: { + /** @description The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`. */ + account_subcategories?: ("checking" | "savings")[]; + }; /** InvoiceRenderingPdf */ invoice_rendering_pdf: { /** @@ -12772,7 +12987,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -12826,7 +13041,7 @@ export interface components { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ payment_method_options?: components["schemas"]["invoices_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; }; /** InvoicesResourceFromInvoice */ invoices_resource_from_invoice: { @@ -12845,10 +13060,10 @@ export interface components { /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -12932,6 +13147,10 @@ export interface components { created: number; /** @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; + /** @description Fleet-specific information for authorizations using Fleet cards. */ + fleet?: components["schemas"]["issuing_authorization_fleet_data"] | null; + /** @description Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. */ + fuel?: components["schemas"]["issuing_authorization_fuel_data"] | null; /** @description Unique identifier for the object. */ id: string; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ @@ -12943,7 +13162,7 @@ export interface components { merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Details about the authorization, such as identifiers, set by the card network. */ network_data?: components["schemas"]["issuing_authorization_network_data"] | null; @@ -13007,7 +13226,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ number?: string; @@ -13068,7 +13287,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The cardholder's name. This will be printed on cards issued to them. */ name: string; @@ -13126,7 +13345,7 @@ export interface components { loss_reason?: "cardholder_authentication_issuer_liability" | "eci5_token_transaction_with_tavv" | "excess_disputes_in_timeframe" | "has_not_met_the_minimum_dispute_amount_requirements" | "invalid_duplicate_dispute" | "invalid_incorrect_amount_dispute" | "invalid_no_authorization" | "invalid_use_of_disputes" | "merchandise_delivered_or_shipped" | "merchandise_or_service_as_described" | "not_cancelled" | "other" | "refund_issued" | "submitted_beyond_allowable_time_limit" | "transaction_3ds_required" | "transaction_approved_after_prior_fraud_dispute" | "transaction_authorized" | "transaction_electronically_read" | "transaction_qualifies_for_visa_easy_payment_service" | "transaction_unattended"; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -13165,7 +13384,7 @@ export interface components { lookup_key?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Friendly display name. */ name?: string | null; @@ -13236,7 +13455,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The total net amount required to settle with the network. */ net_total: number; @@ -13349,7 +13568,7 @@ export interface components { merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Details about the transaction, such as processing dates, set by the card network. */ network_data?: components["schemas"]["issuing_transaction_network_data"] | null; @@ -13395,6 +13614,101 @@ export interface components { */ type: "low_value_transaction" | "transaction_risk_analysis" | "unknown"; }; + /** IssuingAuthorizationFleetCardholderPromptData */ + issuing_authorization_fleet_cardholder_prompt_data: { + /** @description [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. */ + alphanumeric_id?: string | null; + /** @description Driver ID. */ + driver_id?: string | null; + /** @description Odometer reading. */ + odometer?: number | null; + /** @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + unspecified_id?: string | null; + /** @description User ID. */ + user_id?: string | null; + /** @description Vehicle number. */ + vehicle_number?: string | null; + }; + /** IssuingAuthorizationFleetData */ + issuing_authorization_fleet_data: { + /** @description Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry. */ + cardholder_prompt_data?: components["schemas"]["issuing_authorization_fleet_cardholder_prompt_data"] | null; + /** + * @description The type of purchase. + * @enum {string|null} + */ + purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase" | null; + /** @description More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + reported_breakdown?: components["schemas"]["issuing_authorization_fleet_reported_breakdown"] | null; + /** + * @description The type of fuel service. + * @enum {string|null} + */ + service_type?: "full_service" | "non_fuel_transaction" | "self_service" | null; + }; + /** IssuingAuthorizationFleetFuelPriceData */ + issuing_authorization_fleet_fuel_price_data: { + /** + * Format: decimal + * @description Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes. + */ + gross_amount_decimal?: string | null; + }; + /** IssuingAuthorizationFleetNonFuelPriceData */ + issuing_authorization_fleet_non_fuel_price_data: { + /** + * Format: decimal + * @description Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. + */ + gross_amount_decimal?: string | null; + }; + /** IssuingAuthorizationFleetReportedBreakdown */ + issuing_authorization_fleet_reported_breakdown: { + /** @description Breakdown of fuel portion of the purchase. */ + fuel?: components["schemas"]["issuing_authorization_fleet_fuel_price_data"] | null; + /** @description Breakdown of non-fuel portion of the purchase. */ + non_fuel?: components["schemas"]["issuing_authorization_fleet_non_fuel_price_data"] | null; + /** @description Information about tax included in this transaction. */ + tax?: components["schemas"]["issuing_authorization_fleet_tax_data"] | null; + }; + /** IssuingAuthorizationFleetTaxData */ + issuing_authorization_fleet_tax_data: { + /** + * Format: decimal + * @description Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax. + */ + local_amount_decimal?: string | null; + /** + * Format: decimal + * @description Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax. + */ + national_amount_decimal?: string | null; + }; + /** IssuingAuthorizationFuelData */ + issuing_authorization_fuel_data: { + /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + industry_product_code?: string | null; + /** + * Format: decimal + * @description The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. + */ + quantity_decimal?: string | null; + /** + * @description The type of fuel that was purchased. + * @enum {string|null} + */ + type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super" | null; + /** + * @description The units for `quantity_decimal`. + * @enum {string|null} + */ + unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon" | null; + /** + * Format: decimal + * @description The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. + */ + unit_cost_decimal?: string | null; + }; /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { /** @description A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. */ @@ -13471,7 +13785,7 @@ export interface components { * @description When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome. * @enum {string} */ - reason: "account_disabled" | "card_active" | "card_inactive" | "cardholder_inactive" | "cardholder_verification_required" | "insufficient_funds" | "not_allowed" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; + reason: "account_disabled" | "card_active" | "card_canceled" | "card_expired" | "card_inactive" | "cardholder_blocked" | "cardholder_inactive" | "cardholder_verification_required" | "insecure_authorization_method" | "insufficient_funds" | "not_allowed" | "pin_blocked" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; /** @description If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field. */ reason_message?: string | null; /** @@ -13564,6 +13878,8 @@ export interface components { /** IssuingCardShipping */ issuing_card_shipping: { address: components["schemas"]["address"]; + /** @description Address validation details for the shipment. */ + address_validation?: components["schemas"]["issuing_card_shipping_address_validation"] | null; /** * @description The delivery company that shipped a card. * @enum {string|null} @@ -13602,6 +13918,21 @@ export interface components { */ type: "bulk" | "individual"; }; + /** IssuingCardShippingAddressValidation */ + issuing_card_shipping_address_validation: { + /** + * @description The address validation capabilities to use. + * @enum {string} + */ + mode: "disabled" | "normalization_only" | "validation_and_normalization"; + /** @description The normalized shipping address. */ + normalized_address?: components["schemas"]["address"] | null; + /** + * @description The validation result for the shipping address. + * @enum {string|null} + */ + result?: "indeterminate" | "likely_deliverable" | "likely_undeliverable" | null; + }; /** IssuingCardShippingCustoms */ issuing_card_shipping_customs: { /** @description A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. */ @@ -14026,6 +14357,68 @@ export interface components { /** @description The amount of cash requested by the cardholder. */ cashback_amount?: number | null; }; + /** IssuingTransactionFleetCardholderPromptData */ + issuing_transaction_fleet_cardholder_prompt_data: { + /** @description Driver ID. */ + driver_id?: string | null; + /** @description Odometer reading. */ + odometer?: number | null; + /** @description An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + unspecified_id?: string | null; + /** @description User ID. */ + user_id?: string | null; + /** @description Vehicle number. */ + vehicle_number?: string | null; + }; + /** IssuingTransactionFleetData */ + issuing_transaction_fleet_data: { + /** @description Answers to prompts presented to cardholder at point of sale. */ + cardholder_prompt_data?: components["schemas"]["issuing_transaction_fleet_cardholder_prompt_data"] | null; + /** @description The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. */ + purchase_type?: string | null; + /** @description More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + reported_breakdown?: components["schemas"]["issuing_transaction_fleet_reported_breakdown"] | null; + /** @description The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. */ + service_type?: string | null; + }; + /** IssuingTransactionFleetFuelPriceData */ + issuing_transaction_fleet_fuel_price_data: { + /** + * Format: decimal + * @description Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes. + */ + gross_amount_decimal?: string | null; + }; + /** IssuingTransactionFleetNonFuelPriceData */ + issuing_transaction_fleet_non_fuel_price_data: { + /** + * Format: decimal + * @description Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. + */ + gross_amount_decimal?: string | null; + }; + /** IssuingTransactionFleetReportedBreakdown */ + issuing_transaction_fleet_reported_breakdown: { + /** @description Breakdown of fuel portion of the purchase. */ + fuel?: components["schemas"]["issuing_transaction_fleet_fuel_price_data"] | null; + /** @description Breakdown of non-fuel portion of the purchase. */ + non_fuel?: components["schemas"]["issuing_transaction_fleet_non_fuel_price_data"] | null; + /** @description Information about tax included in this transaction. */ + tax?: components["schemas"]["issuing_transaction_fleet_tax_data"] | null; + }; + /** IssuingTransactionFleetTaxData */ + issuing_transaction_fleet_tax_data: { + /** + * Format: decimal + * @description Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax. + */ + local_amount_decimal?: string | null; + /** + * Format: decimal + * @description Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax. + */ + national_amount_decimal?: string | null; + }; /** IssuingTransactionFlightData */ issuing_transaction_flight_data: { /** @description The time that the flight departed. */ @@ -14056,6 +14449,8 @@ export interface components { }; /** IssuingTransactionFuelData */ issuing_transaction_fuel_data: { + /** @description [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + industry_product_code?: string | null; /** * Format: decimal * @description The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. @@ -14089,6 +14484,8 @@ export interface components { }; /** IssuingTransactionPurchaseDetails */ issuing_transaction_purchase_details: { + /** @description Fleet-specific information for transactions using Fleet cards. */ + fleet?: components["schemas"]["issuing_transaction_fleet_data"] | null; /** @description Information about the flight that was purchased with this transaction. */ flight?: components["schemas"]["issuing_transaction_flight_data"] | null; /** @description Information about fuel that was purchased with this transaction. */ @@ -14294,7 +14691,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -14350,6 +14747,7 @@ export interface components { }; /** linked_account_options_us_bank_account */ linked_account_options_us_bank_account: { + filters?: components["schemas"]["payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description Data features requested to be retrieved upon account creation. */ @@ -14722,6 +15120,11 @@ export interface components { /** @description The four-digit year of birth. */ year?: number | null; }; + /** PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters */ + payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters: { + /** @description The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`. */ + account_subcategories?: ("checking" | "savings")[]; + }; /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -14787,7 +15190,7 @@ export interface components { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -14797,13 +15200,13 @@ export interface components { invoice?: (string | components["schemas"]["invoice"]) | null; /** @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. */ last_payment_error?: components["schemas"]["api_errors"] | null; - /** @description The latest charge created by this PaymentIntent. */ + /** @description ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. */ latest_charge?: (string | components["schemas"]["charge"]) | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. */ next_action?: components["schemas"]["payment_intent_next_action"] | null; @@ -14833,6 +15236,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string|null} */ @@ -15187,6 +15592,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15204,6 +15611,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15216,6 +15625,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15271,6 +15682,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15287,6 +15700,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15304,6 +15719,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15340,6 +15757,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15353,6 +15772,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15367,6 +15788,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15386,6 +15809,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15423,6 +15848,8 @@ export interface components { */ capture_method?: "manual" | "manual_preferred"; installments?: components["schemas"]["payment_flows_installment_options"]; + /** @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + request_incremental_authorization_support?: boolean; /** @description When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). */ require_cvc_recollection?: boolean; routing?: components["schemas"]["payment_method_options_card_present_routing"]; @@ -15431,6 +15858,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -15506,7 +15935,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -15523,7 +15952,7 @@ export interface components { */ payment_method_collection: "always" | "if_required"; /** @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; /** @description Settings that restrict the usage of a payment link. */ restrictions?: components["schemas"]["payment_links_resource_restrictions"] | null; @@ -15682,7 +16111,7 @@ export interface components { issuer?: components["schemas"]["connect_account_reference"] | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description Options for invoice PDF rendering. */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; @@ -15698,7 +16127,7 @@ export interface components { description?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description Indicates that you intend to make future payments with the payment method collected during checkout. @@ -15750,7 +16179,7 @@ export interface components { invoice_settings: components["schemas"]["payment_links_resource_subscription_data_invoice_settings"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ trial_period_days?: number | null; @@ -15824,7 +16253,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; mobilepay?: components["schemas"]["payment_method_mobilepay"]; multibanco?: components["schemas"]["payment_method_multibanco"]; @@ -15953,10 +16382,14 @@ export interface components { payment_method_card_present: { /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; + /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + brand_product?: string | null; /** @description The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ cardholder_name?: string | null; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; + /** @description A high-level description of the type of cards issued in this range. */ + description?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ @@ -15967,6 +16400,8 @@ export interface components { fingerprint?: string | null; /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ funding?: string | null; + /** @description The name of the card's issuing bank. */ + issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; /** @description Contains information about card networks that can be used to process the payment. */ @@ -16143,6 +16578,7 @@ export interface components { sepa_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; sofort?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; swish?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + twint?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; us_bank_account?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; wechat_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; zip?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -16244,7 +16680,10 @@ export interface components { transit_number?: string | null; }; /** payment_method_details_affirm */ - payment_method_details_affirm: Record; + payment_method_details_affirm: { + /** @description The Affirm transaction ID associated with this payment. */ + transaction_id?: string | null; + }; /** payment_method_details_afterpay_clearpay */ payment_method_details_afterpay_clearpay: { /** @description The Afterpay order ID associated with this payment intent. */ @@ -16301,7 +16740,10 @@ export interface components { verified_name?: string | null; }; /** payment_method_details_blik */ - payment_method_details_blik: Record; + payment_method_details_blik: { + /** @description A unique and immutable identifier assigned by BLIK to every buyer. */ + buyer_id?: string | null; + }; /** payment_method_details_boleto */ payment_method_details_boleto: { /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ @@ -16394,6 +16836,8 @@ export interface components { amount_authorized?: number | null; /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; + /** @description The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + brand_product?: string | null; /** * Format: unix-time * @description When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. @@ -16403,6 +16847,8 @@ export interface components { cardholder_name?: string | null; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; + /** @description A high-level description of the type of cards issued in this range. */ + description?: string | null; /** @description Authorization response cryptogram. */ emv_auth_data?: string | null; /** @description Two-digit number representing the card's expiration month. */ @@ -16419,10 +16865,17 @@ export interface components { generated_card?: string | null; /** @description Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). */ incremental_authorization_supported: boolean; + /** @description The name of the card's issuing bank. */ + issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; + /** @description This is used by the financial networks to identify a transaction. + * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. + * The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). + * This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + network_transaction_id?: string | null; /** @description Details about payments collected offline. */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; /** @description Defines whether the authorized amount can be over-captured or not */ @@ -16597,6 +17050,8 @@ export interface components { cardholder_name?: string | null; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; + /** @description A high-level description of the type of cards issued in this range. */ + description?: string | null; /** @description Authorization response cryptogram. */ emv_auth_data?: string | null; /** @description Two-digit number representing the card's expiration month. */ @@ -16611,10 +17066,17 @@ export interface components { funding?: string | null; /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ generated_card?: string | null; + /** @description The name of the card's issuing bank. */ + issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; + /** @description This is used by the financial networks to identify a transaction. + * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. + * The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). + * This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + network_transaction_id?: string | null; /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ preferred_locales?: string[] | null; /** @@ -16835,7 +17297,7 @@ export interface components { * @description A payment method domain represents a web domain that you have registered with Stripe. * Stripe Elements use registered payment method domains to control where certain payment methods are shown. * - * Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + * Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). */ payment_method_domain: { apple_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; @@ -16922,6 +17384,8 @@ export interface components { cardholder_name?: string | null; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; + /** @description A high-level description of the type of cards issued in this range. */ + description?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ @@ -16932,6 +17396,8 @@ export interface components { fingerprint?: string | null; /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ funding?: string | null; + /** @description The name of the card's issuing bank. */ + issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; /** @description Contains information about card networks that can be used to process the payment. */ @@ -16974,6 +17440,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -16994,6 +17462,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17006,6 +17476,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17023,6 +17495,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17035,6 +17509,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17052,6 +17528,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17066,6 +17544,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17141,6 +17621,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17159,6 +17641,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17192,6 +17676,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17204,6 +17690,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17216,6 +17704,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17228,6 +17718,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17249,6 +17741,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17272,6 +17766,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17284,6 +17780,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17298,6 +17796,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17310,6 +17810,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17322,6 +17824,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17343,6 +17847,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17359,6 +17865,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17371,6 +17879,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17388,6 +17898,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17405,6 +17917,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17417,6 +17931,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17444,6 +17960,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17456,6 +17974,8 @@ export interface components { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -17756,7 +18276,7 @@ export interface components { issuer?: components["schemas"]["connect_account_reference"] | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description Options for invoice PDF rendering. */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; @@ -17820,10 +18340,10 @@ export interface components { /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -17901,7 +18421,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). */ method: string; @@ -18004,7 +18524,7 @@ export interface components { maiden_name?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The country where the person is a national. */ nationality?: string | null; @@ -18141,7 +18661,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description The meter tracking the usage of a metered price */ meter?: string | null; @@ -18404,7 +18924,7 @@ export interface components { currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { - [key: string]: components["schemas"]["currency_option"] | undefined; + [key: string]: components["schemas"]["currency_option"]; }; /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ custom_unit_amount?: components["schemas"]["custom_unit_amount"] | null; @@ -18416,7 +18936,7 @@ export interface components { lookup_key?: string | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description A brief description of the price, hidden from customers. */ nickname?: string | null; @@ -18508,7 +19028,7 @@ export interface components { marketing_features: components["schemas"]["product_marketing_feature"][]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The product's name, meant to be displayable to the customer. */ name: string; @@ -18588,7 +19108,7 @@ export interface components { max_redemptions?: number | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -18608,7 +19128,7 @@ export interface components { promotion_codes_resource_restrictions: { /** @description Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { - [key: string]: components["schemas"]["promotion_code_currency_option"] | undefined; + [key: string]: components["schemas"]["promotion_code_currency_option"]; }; /** @description A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ first_time_transaction: boolean; @@ -18692,7 +19212,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). */ number?: string | null; @@ -18789,7 +19309,7 @@ export interface components { effective_date?: number | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ trial_period_days?: number | null; @@ -18920,7 +19440,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The name of the value list. */ name: string; @@ -19057,7 +19577,7 @@ export interface components { instructions_email?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; next_action?: components["schemas"]["refund_next_action"]; /** @@ -19667,7 +20187,7 @@ export interface components { mandate?: (string | components["schemas"]["mandate"]) | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ next_action?: components["schemas"]["setup_intent_next_action"] | null; @@ -19678,7 +20198,7 @@ export interface components { object: "setup_intent"; /** @description The account (if any) for which the setup is intended. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used with this SetupIntent. */ + /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ payment_method?: (string | components["schemas"]["payment_method"]) | null; /** @description Information about the payment method configuration used for this Setup Intent. */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; @@ -19734,7 +20254,7 @@ export interface components { setup_intent_payment_method_options: { acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; amazon_pay?: components["schemas"]["setup_intent_payment_method_options_amazon_pay"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; - card?: components["schemas"]["setup_intent_payment_method_options_card"]; + card?: components["schemas"]["setup_intent_payment_method_options_card"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card_present?: components["schemas"]["setup_intent_payment_method_options_card_present"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["setup_intent_payment_method_options_link"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; paypal?: components["schemas"]["setup_intent_payment_method_options_paypal"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; @@ -19895,7 +20415,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -19950,7 +20470,7 @@ export interface components { currency: string; /** @description Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { - [key: string]: components["schemas"]["shipping_rate_currency_option"] | undefined; + [key: string]: components["schemas"]["shipping_rate_currency_option"]; }; }; /** SigmaScheduledQueryRunError */ @@ -20006,7 +20526,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; multibanco?: components["schemas"]["source_type_multibanco"]; /** @@ -20482,7 +21002,7 @@ export interface components { * @description A date in the future at which the subscription will automatically get canceled */ cancel_at?: number | null; - /** @description If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period. */ + /** @description Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. */ cancel_at_period_end: boolean; /** * Format: unix-time @@ -20560,7 +21080,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * Format: unix-time @@ -20642,7 +21162,7 @@ export interface components { /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. * *Note: This attribute is populated only for invoices created on or after June 29, 2023.* */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; }; /** @@ -20661,7 +21181,7 @@ export interface components { id: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -20745,7 +21265,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -20796,7 +21316,7 @@ export interface components { discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description ID of the price to which the customer should be subscribed. */ price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; @@ -20863,7 +21383,7 @@ export interface components { items: components["schemas"]["subscription_schedule_configuration_item"][]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; @@ -20978,9 +21498,9 @@ export interface components { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ payment_method_options?: components["schemas"]["subscriptions_resource_payment_method_options"] | null; /** @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; /** - * @description Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. + * @description Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. * @enum {string|null} */ save_default_payment_method?: "off" | "on_subscription" | null; @@ -21042,7 +21562,7 @@ export interface components { * Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom) */ "tax.calculation": { - /** @description Total after taxes. */ + /** @description Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_total: number; /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; @@ -21233,13 +21753,18 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "tax.transaction"; + /** + * Format: unix-time + * @description The Unix timestamp representing when the tax liability is assumed or reduced. + */ + posted_at: number; /** @description A custom unique identifier, such as 'myOrder_123'. */ reference: string; /** @description If `type=reversal`, contains information about what was reversed. */ @@ -21271,7 +21796,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -21381,10 +21906,10 @@ export interface components { /** @description The account or customer the tax ID belongs to. */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -21552,10 +22077,10 @@ export interface components { /** TaxProductResourceCustomerDetailsResourceTaxId */ tax_product_resource_customer_details_resource_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value: string; }; @@ -21762,7 +22287,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -21799,6 +22324,7 @@ export interface components { */ object: "terminal.configuration"; offline?: components["schemas"]["terminal_configuration_configuration_resource_offline_config"]; + reboot_window?: components["schemas"]["terminal_configuration_configuration_resource_reboot_window"]; stripe_s700?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; tipping?: components["schemas"]["terminal_configuration_configuration_resource_tipping"]; verifone_p400?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; @@ -21838,7 +22364,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -21858,10 +22384,10 @@ export interface components { /** @description The current software version of the reader. */ device_sw_version?: string | null; /** - * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. + * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; + device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "verifone_P400"; /** @description Unique identifier for the object. */ id: string; /** @description The local IP address of the reader. */ @@ -21874,7 +22400,7 @@ export interface components { location?: (string | components["schemas"]["terminal.location"]) | null; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -21908,6 +22434,13 @@ export interface components { /** @description Determines whether to allow transactions to be collected while reader is offline. Defaults to false. */ enabled?: boolean | null; }; + /** TerminalConfigurationConfigurationResourceRebootWindow */ + terminal_configuration_configuration_resource_reboot_window: { + /** @description Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour. */ + end_hour: number; + /** @description Integer between 0 to 23 that represents the start hour of the reboot time window. */ + start_hour: number; + }; /** TerminalConfigurationConfigurationResourceTipping */ terminal_configuration_configuration_resource_tipping: { aud?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; @@ -22025,7 +22558,7 @@ export interface components { charge?: string | components["schemas"]["charge"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Payment intent that is being refunded. */ payment_intent?: string | components["schemas"]["payment_intent"]; @@ -22277,7 +22810,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22335,7 +22868,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22411,7 +22944,7 @@ export interface components { id: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22478,7 +23011,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description The rails used to reverse the funds. @@ -22527,7 +23060,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description The rails used to reverse the funds. @@ -22575,7 +23108,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22647,7 +23180,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22714,7 +23247,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22774,7 +23307,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -23058,15 +23591,15 @@ export interface components { treasury_financial_accounts_resource_balance: { /** @description Funds the user can spend right now. */ cash: { - [key: string]: number | undefined; + [key: string]: number; }; /** @description Funds not spendable yet, but will become available at a later time. */ inbound_pending: { - [key: string]: number | undefined; + [key: string]: number; }; /** @description Funds in the account, but not spendable because they are being held for pending outbound flows. */ outbound_pending: { - [key: string]: number | undefined; + [key: string]: number; }; }; /** TreasuryFinancialAccountsResourceClosedStatusDetails */ @@ -23578,7 +24111,7 @@ export interface components { livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -23796,6 +24329,18 @@ export interface operations { /** base_features_param */ features?: Record; }; + /** base_config_param */ + tax_registrations?: { + enabled: boolean; + /** base_features_param */ + features?: Record; + }; + /** base_config_param */ + tax_settings?: { + enabled: boolean; + /** base_features_param */ + features?: Record; + }; }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -24340,7 +24885,7 @@ export interface operations { last_name_kanji?: string; maiden_name?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; phone?: string; /** @enum {string} */ @@ -24379,7 +24924,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * settings_specs @@ -24940,7 +25485,7 @@ export interface operations { last_name_kanji?: string; maiden_name?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; phone?: string; /** @enum {string} */ @@ -24979,7 +25524,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * settings_specs_update @@ -25164,7 +25709,7 @@ export interface operations { external_account?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -25286,7 +25831,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Cardholder name. */ name?: string; @@ -25580,7 +26125,7 @@ export interface operations { external_account?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -25702,7 +26247,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Cardholder name. */ name?: string; @@ -25982,7 +26527,7 @@ export interface operations { maiden_name?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; @@ -26214,7 +26759,7 @@ export interface operations { maiden_name?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; @@ -26505,7 +27050,7 @@ export interface operations { maiden_name?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; @@ -26737,7 +27282,7 @@ export interface operations { maiden_name?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; @@ -27172,7 +27717,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -27350,7 +27895,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -27896,7 +28441,7 @@ export interface operations { identifier?: string; /** @description The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ payload: { - [key: string]: string | undefined; + [key: string]: string; }; /** * Format: unix-time @@ -28175,7 +28720,7 @@ export interface operations { query: { /** @description The customer for which to fetch event summaries. */ customer: string; - /** @description The timestamp from when to stop aggregating meter events (exclusive). */ + /** @description The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries. */ end_time: number; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; @@ -28183,12 +28728,12 @@ export interface operations { expand?: string[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; - /** @description The timestamp from when to start aggregating meter events (inclusive). */ + /** @description The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries. */ start_time: number; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. */ - value_grouping_window?: "hour"; + /** @description Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC). */ + value_grouping_window?: "day" | "hour"; }; header?: never; path: { @@ -28405,7 +28950,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -28548,7 +29093,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -28769,7 +29314,7 @@ export interface operations { exp_month: number; exp_year: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name?: string; number: string; @@ -28790,7 +29335,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). */ on_behalf_of?: string; @@ -28982,7 +29527,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address. */ receipt_email?: string; @@ -29177,7 +29722,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ submit?: boolean; @@ -29264,7 +29809,7 @@ export interface operations { instructions_email?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The identifier of the PaymentIntent to refund. */ payment_intent?: string; @@ -29381,7 +29926,7 @@ export interface operations { instructions_email?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * @description Origin of the refund @@ -29478,7 +30023,7 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -29770,7 +30315,7 @@ export interface operations { type: "account" | "self"; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; rendering_options?: { /** @enum {string} */ @@ -29801,7 +30346,7 @@ export interface operations { description?: string; images?: string[]; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name: string; tax_code?: string; @@ -29828,7 +30373,7 @@ export interface operations { locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-GB" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW"; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item. @@ -29845,7 +30390,7 @@ export interface operations { capture_method?: "automatic" | "automatic_async" | "manual"; description?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; receipt_email?: string; @@ -30166,7 +30711,7 @@ export interface operations { setup_intent_data?: { description?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; }; @@ -30207,11 +30752,11 @@ export interface operations { amount: number; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - } | undefined; + }; }; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -30247,7 +30792,7 @@ export interface operations { }; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; /** @enum {string} */ @@ -30349,6 +30894,48 @@ export interface operations { }; }; }; + PostCheckoutSessionsSession: { + parameters: { + query?: never; + header?: never; + path: { + session: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["checkout.session"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostCheckoutSessionsSessionExpire: { parameters: { query?: never; @@ -30521,7 +31108,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * Format: decimal @@ -30614,7 +31201,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -31075,7 +31662,7 @@ export interface operations { currency_options?: { [key: string]: { amount_off: number; - } | undefined; + }; }; /** * @description Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`. @@ -31092,7 +31679,7 @@ export interface operations { max_redemptions?: number; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ name?: string; @@ -31181,13 +31768,13 @@ export interface operations { currency_options?: { [key: string]: { amount_off: number; - } | undefined; + }; }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set. */ name?: string; @@ -31333,6 +31920,11 @@ export interface operations { * @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. */ effective_at?: number; + /** + * @description Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`. + * @enum {string} + */ + email_type?: "credit_note" | "none"; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description ID of the invoice. */ @@ -31359,7 +31951,7 @@ export interface operations { memo?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. */ out_of_band_amount?: number; @@ -31412,6 +32004,8 @@ export interface operations { credit_amount?: number; /** @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. */ effective_at?: number; + /** @description Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`. */ + email_type?: "credit_note" | "none"; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description ID of the invoice. */ @@ -31438,7 +32032,7 @@ export interface operations { memo?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. */ out_of_band_amount?: number; @@ -31492,6 +32086,8 @@ export interface operations { credit_amount?: number; /** @description The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. */ effective_at?: number; + /** @description Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`. */ + email_type?: "credit_note" | "none"; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -31522,7 +32118,7 @@ export interface operations { memo?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. */ out_of_band_amount?: number; @@ -31693,7 +32289,7 @@ export interface operations { memo?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -31776,12 +32372,29 @@ export interface operations { buy_button?: { enabled: boolean; }; + /** payment_element_param */ + payment_element?: { + enabled: boolean; + /** features_param */ + features?: { + payment_method_allow_redisplay_filters?: ("always" | "limited" | "unspecified")[]; + /** @enum {string} */ + payment_method_redisplay?: "disabled" | "enabled"; + payment_method_redisplay_limit?: number; + /** @enum {string} */ + payment_method_remove?: "disabled" | "enabled"; + /** @enum {string} */ + payment_method_save?: "disabled" | "enabled"; + /** @enum {string} */ + payment_method_save_usage?: "off_session" | "on_session"; + }; + }; /** pricing_table_param */ pricing_table?: { enabled: boolean; }; }; - /** @description The ID of an existing customer for which to create the customer session. */ + /** @description The ID of an existing customer for which to create the Customer Session. */ customer: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -31932,7 +32545,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The customer's full name or business name. */ name?: string; @@ -31977,7 +32590,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -32145,7 +32758,7 @@ export interface operations { exp_month: number; exp_year: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name?: string; number: string; @@ -32202,7 +32815,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The customer's full name or business name. */ name?: string; @@ -32380,7 +32993,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -32464,7 +33077,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -32584,7 +33197,7 @@ export interface operations { exp_month: number; exp_year: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name?: string; number: string; @@ -32595,7 +33208,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ source?: string; @@ -32702,7 +33315,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Cardholder name. */ name?: string; @@ -32918,7 +33531,7 @@ export interface operations { exp_month: number; exp_year: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name?: string; number: string; @@ -32929,7 +33542,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ source?: string; @@ -33036,7 +33649,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Cardholder name. */ name?: string; @@ -33622,7 +34235,7 @@ export interface operations { exp_month: number; exp_year: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name?: string; number: string; @@ -33633,7 +34246,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ source?: string; @@ -33740,7 +34353,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Cardholder name. */ name?: string; @@ -33987,7 +34600,7 @@ export interface operations { * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ cancel_at?: number; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ + /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. @@ -34038,7 +34651,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -34062,9 +34675,9 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ + /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; /** * @description Only applies to subscriptions with `collection_method=charge_automatically`. @@ -34130,6 +34743,10 @@ export interface operations { us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { + /** invoice_linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; }; @@ -34137,7 +34754,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -34303,7 +34920,7 @@ export interface operations { } | ""; /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ cancel_at?: number | ""; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ + /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** * cancellation_details_param @@ -34364,7 +34981,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -34388,9 +35005,9 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ + /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ pause_collection?: { @@ -34459,6 +35076,10 @@ export interface operations { us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { + /** invoice_linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; }; @@ -34466,7 +35087,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -34721,10 +35342,10 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -34831,6 +35452,7 @@ export interface operations { query?: { /** @description Only return disputes associated to the charge specified by this charge ID. */ charge?: string; + /** @description Only return disputes that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -34976,7 +35598,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). */ submit?: boolean; @@ -35209,7 +35831,7 @@ export interface operations { lookup_key: string; /** @description Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The feature's name, for your own purpose, not meant to be displayable to the customer. */ name: string; @@ -35294,7 +35916,7 @@ export interface operations { expand?: string[]; /** @description Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The feature's name, for your own purpose, not meant to be displayable to the customer. */ name?: string; @@ -35685,7 +36307,7 @@ export interface operations { file: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -35767,7 +36389,7 @@ export interface operations { expires_at?: "now" | number | ""; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -35881,7 +36503,7 @@ export interface operations { /** Format: unix-time */ expires_at?: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; /** @@ -36293,6 +36915,7 @@ export interface operations { * @description Filters to restrict the kinds of accounts to collect. */ filters?: { + account_subcategories?: ("checking" | "credit_card" | "line_of_credit" | "mortgage" | "savings")[]; countries?: string[]; }; /** @description List of data features that you would like to request access to. @@ -36805,7 +37428,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * session_options_param @@ -36914,7 +37537,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * session_options_param @@ -37139,7 +37762,7 @@ export interface operations { invoice?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * period @@ -37276,7 +37899,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * period @@ -37547,7 +38170,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. */ number?: string; @@ -37605,6 +38228,10 @@ export interface operations { us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { + /** invoice_linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; }; @@ -37612,7 +38239,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; }; /** * @description How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. @@ -37665,11 +38292,11 @@ export interface operations { amount: number; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - } | undefined; + }; }; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -37794,7 +38421,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -37819,7 +38446,7 @@ export interface operations { }[] | ""; invoiceitem?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** period */ period?: { @@ -37944,7 +38571,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -37968,7 +38595,7 @@ export interface operations { }[]; iterations?: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; /** @enum {string} */ @@ -38010,7 +38637,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -38170,7 +38797,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -38195,7 +38822,7 @@ export interface operations { }[] | ""; invoiceitem?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** period */ period?: { @@ -38311,7 +38938,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -38335,7 +38962,7 @@ export interface operations { }[]; iterations?: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; /** @enum {string} */ @@ -38358,7 +38985,7 @@ export interface operations { subscription_billing_cycle_anchor?: ("now" | "unchanged") | number; /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ subscription_cancel_at?: number | ""; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ + /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ subscription_cancel_at_period_end?: boolean; /** @description This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ subscription_cancel_now?: boolean; @@ -38384,7 +39011,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -38430,7 +39057,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -38543,7 +39170,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -38570,7 +39197,7 @@ export interface operations { }[] | ""; invoiceitem?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** period */ period?: { @@ -38688,7 +39315,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -38712,7 +39339,7 @@ export interface operations { }[]; iterations?: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; /** @enum {string} */ @@ -38737,7 +39364,7 @@ export interface operations { subscription_billing_cycle_anchor?: ("now" | "unchanged") | number; /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ subscription_cancel_at?: number | ""; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ + /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ subscription_cancel_at_period_end?: boolean; /** @description This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ subscription_cancel_now?: boolean; @@ -38763,7 +39390,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -38809,7 +39436,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -39001,7 +39628,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. */ number?: string | ""; @@ -39059,6 +39686,10 @@ export interface operations { us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { + /** invoice_linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; }; @@ -39066,7 +39697,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; }; /** * rendering_param @@ -39111,11 +39742,11 @@ export interface operations { amount: number; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - } | undefined; + }; }; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -39204,6 +39835,109 @@ export interface operations { }; }; }; + PostInvoicesInvoiceAddLines: { + parameters: { + query?: never; + header?: never; + path: { + invoice: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + invoice_metadata?: { + [key: string]: string; + } | ""; + /** @description The line items to add. */ + lines: { + amount?: number; + description?: string; + discountable?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + invoice_item?: string; + metadata?: { + [key: string]: string; + } | ""; + /** period */ + period?: { + /** Format: unix-time */ + end: number; + /** Format: unix-time */ + start: number; + }; + price?: string; + /** one_time_price_data_with_product_data */ + price_data?: { + currency: string; + product?: string; + /** product_data */ + product_data?: { + description?: string; + images?: string[]; + metadata?: { + [key: string]: string; + }; + name: string; + tax_code?: string; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_amounts?: { + amount: number; + /** tax_rate_data_param */ + tax_rate_data: { + country?: string; + description?: string; + display_name: string; + inclusive: boolean; + jurisdiction?: string; + percentage: number; + state?: string; + /** @enum {string} */ + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + }; + taxable_amount: number; + }[] | ""; + tax_rates?: string[] | ""; + }[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostInvoicesInvoiceFinalize: { parameters: { query?: never; @@ -39329,9 +40063,9 @@ export interface operations { }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data. */ + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * period @@ -39357,7 +40091,7 @@ export interface operations { description?: string; images?: string[]; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name: string; tax_code?: string; @@ -39503,6 +40237,54 @@ export interface operations { }; }; }; + PostInvoicesInvoiceRemoveLines: { + parameters: { + query?: never; + header?: never; + path: { + invoice: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + invoice_metadata?: { + [key: string]: string; + } | ""; + /** @description The line items to remove. */ + lines: { + /** @enum {string} */ + behavior: "delete" | "unassign"; + id: string; + }[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostInvoicesInvoiceSend: { parameters: { query?: never; @@ -39541,6 +40323,109 @@ export interface operations { }; }; }; + PostInvoicesInvoiceUpdateLines: { + parameters: { + query?: never; + header?: never; + path: { + invoice: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. */ + invoice_metadata?: { + [key: string]: string; + } | ""; + /** @description The line items to update. */ + lines: { + amount?: number; + description?: string; + discountable?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + id: string; + metadata?: { + [key: string]: string; + } | ""; + /** period */ + period?: { + /** Format: unix-time */ + end: number; + /** Format: unix-time */ + start: number; + }; + price?: string; + /** one_time_price_data_with_product_data */ + price_data?: { + currency: string; + product?: string; + /** product_data */ + product_data?: { + description?: string; + images?: string[]; + metadata?: { + [key: string]: string; + }; + name: string; + tax_code?: string; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_amounts?: { + amount: number; + /** tax_rate_data_param */ + tax_rate_data: { + country?: string; + description?: string; + display_name: string; + inclusive: boolean; + jurisdiction?: string; + percentage: number; + state?: string; + /** @enum {string} */ + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; + }; + taxable_amount: number; + }[] | ""; + tax_rates?: string[] | ""; + }[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostInvoicesInvoiceVoid: { parameters: { query?: never; @@ -39699,7 +40584,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -39743,7 +40628,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -39785,7 +40670,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -39949,7 +40834,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers. */ name: string; @@ -40119,7 +41004,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details. */ phone_number?: string; @@ -40264,7 +41149,7 @@ export interface operations { financial_account?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The personalization design object belonging to this card. */ personalization_design?: string; @@ -40298,6 +41183,11 @@ export interface operations { postal_code: string; state?: string; }; + /** address_validation_param */ + address_validation?: { + /** @enum {string} */ + mode: "disabled" | "normalization_only" | "validation_and_normalization"; + }; /** customs_param */ customs?: { eori_number?: string; @@ -40419,7 +41309,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; personalization_design?: string; /** @@ -40429,6 +41319,37 @@ export interface operations { pin?: { encrypted_number?: string; }; + /** + * shipping_specs + * @description Updated shipping information for the card. + */ + shipping?: { + /** required_address */ + address: { + city: string; + country: string; + line1: string; + line2?: string; + postal_code: string; + state?: string; + }; + /** address_validation_param */ + address_validation?: { + /** @enum {string} */ + mode: "disabled" | "normalization_only" | "validation_and_normalization"; + }; + /** customs_param */ + customs?: { + eori_number?: string; + }; + name: string; + phone_number?: string; + require_signature?: boolean; + /** @enum {string} */ + service?: "express" | "priority" | "standard"; + /** @enum {string} */ + type?: "bulk" | "individual"; + }; /** * authorization_controls_param * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. @@ -40623,7 +41544,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. */ transaction?: string; @@ -40783,7 +41704,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -40825,7 +41746,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -40941,7 +41862,7 @@ export interface operations { lookup_key?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Friendly display name. */ name?: string; @@ -41045,7 +41966,7 @@ export interface operations { lookup_key?: string | ""; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Friendly display name. Providing an empty string will set the field to null. */ name?: string | ""; @@ -41233,7 +42154,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -41524,7 +42445,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -41577,6 +42498,7 @@ export interface operations { * @description Filters to restrict the kinds of accounts to collect. */ filters?: { + account_subcategories?: ("checking" | "credit_card" | "line_of_credit" | "mortgage" | "savings")[]; countries?: string[]; }; /** @description List of data features that you would like to request access to. @@ -42029,7 +42951,7 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -42058,7 +42980,7 @@ export interface operations { } | ""; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ off_session?: boolean | ("one_off" | "recurring"); @@ -42164,7 +43086,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -42511,6 +43433,10 @@ export interface operations { us_bank_account?: { /** linked_account_options_param */ financial_connections?: { + /** linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; @@ -42561,6 +43487,8 @@ export interface operations { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * @enum {string} */ @@ -42746,7 +43674,7 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -42754,9 +43682,9 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. */ + /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string. */ payment_method?: string; /** @description The ID of the payment method configuration to use with this PaymentIntent. */ payment_method_configuration?: string; @@ -42854,7 +43782,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -43201,6 +44129,10 @@ export interface operations { us_bank_account?: { /** linked_account_options_param */ financial_connections?: { + /** linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; @@ -43242,9 +44174,11 @@ export interface operations { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * - * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. + * If `setup_future_usage` is already set and you are performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. * @enum {string} */ setup_future_usage?: "" | "off_session" | "on_session"; @@ -43414,7 +44348,7 @@ export interface operations { final_capture?: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string; @@ -43606,7 +44540,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -43953,6 +44887,10 @@ export interface operations { us_bank_account?: { /** linked_account_options_param */ financial_connections?: { + /** linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; @@ -44005,9 +44943,11 @@ export interface operations { * * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. * + * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). * - * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`. + * If `setup_future_usage` is already set and you are performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. * @enum {string} */ setup_future_usage?: "" | "off_session" | "on_session"; @@ -44075,7 +45015,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string; @@ -44356,7 +45296,7 @@ export interface operations { type: "account" | "self"; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; rendering_options?: { /** @enum {string} */ @@ -44377,7 +45317,7 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The account on behalf of which to charge. */ on_behalf_of?: string; @@ -44390,7 +45330,7 @@ export interface operations { capture_method?: "automatic" | "automatic_async" | "manual"; description?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @enum {string} */ setup_future_usage?: "off_session" | "on_session"; @@ -44408,7 +45348,7 @@ export interface operations { */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[]; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -44460,7 +45400,7 @@ export interface operations { }; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; trial_period_days?: number; /** trial_settings_config */ @@ -44678,7 +45618,7 @@ export interface operations { type: "account" | "self"; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; rendering_options?: { /** @enum {string} */ @@ -44699,7 +45639,7 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * payment_intent_data_update_params @@ -44708,7 +45648,7 @@ export interface operations { payment_intent_data?: { description?: string | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; statement_descriptor?: string | ""; statement_descriptor_suffix?: string | ""; @@ -44724,7 +45664,7 @@ export interface operations { */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; /** @description Settings that restrict the usage of a payment link. */ restrictions?: { /** completed_sessions_params */ @@ -44751,7 +45691,7 @@ export interface operations { }; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; trial_settings?: { /** end_behavior */ @@ -45326,6 +46266,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details. + */ + twint?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. @@ -45846,6 +46797,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details. + */ + twint?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. @@ -46358,7 +47320,7 @@ export interface operations { link?: Record; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * param @@ -46588,7 +47550,7 @@ export interface operations { link?: Record; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * update_param @@ -46795,7 +47757,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). @@ -46887,7 +47849,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -46967,7 +47929,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; }; }; @@ -47102,7 +48064,7 @@ export interface operations { interval_count?: number; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The meter tracking the usage of a metered price */ meter?: string; @@ -47113,7 +48075,7 @@ export interface operations { /** @deprecated */ id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name: string; statement_descriptor?: string; @@ -47231,7 +48193,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description A brief description of the plan, hidden from customers. */ nickname?: string; @@ -47420,7 +48382,7 @@ export interface operations { unit_amount?: number; /** Format: decimal */ unit_amount_decimal?: string; - } | undefined; + }; }; /** * custom_unit_amount @@ -47438,7 +48400,7 @@ export interface operations { lookup_key?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description A brief description of the price, hidden from customers. */ nickname?: string; @@ -47453,7 +48415,7 @@ export interface operations { /** @deprecated */ id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; name: string; statement_descriptor?: string; @@ -47666,7 +48628,7 @@ export interface operations { unit_amount?: number; /** Format: decimal */ unit_amount_decimal?: string; - } | undefined; + }; } | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -47674,7 +48636,7 @@ export interface operations { lookup_key?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description A brief description of the price, hidden from customers. */ nickname?: string; @@ -47819,7 +48781,7 @@ export interface operations { unit_amount?: number; /** Format: decimal */ unit_amount_decimal?: string; - } | undefined; + }; }; /** recurring_adhoc */ recurring?: { @@ -47847,7 +48809,7 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The product's name, meant to be displayable to the customer. */ name: string; @@ -48018,7 +48980,7 @@ export interface operations { }[] | ""; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The product's name, meant to be displayable to the customer. */ name?: string; @@ -48370,7 +49332,7 @@ export interface operations { max_redemptions?: number; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * restrictions_params @@ -48380,7 +49342,7 @@ export interface operations { currency_options?: { [key: string]: { minimum_amount?: number; - } | undefined; + }; }; first_time_transaction?: boolean; minimum_amount?: number; @@ -48466,7 +49428,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * restrictions_params @@ -48476,7 +49438,7 @@ export interface operations { currency_options?: { [key: string]: { minimum_amount?: number; - } | undefined; + }; }; }; }; @@ -48667,7 +49629,7 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The account on behalf of which to charge. */ on_behalf_of?: string | ""; @@ -48679,7 +49641,7 @@ export interface operations { description?: string; effective_date?: "current_period_end" | number | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; trial_period_days?: number | ""; }; @@ -48853,7 +49815,7 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The account on behalf of which to charge. */ on_behalf_of?: string | ""; @@ -48865,7 +49827,7 @@ export interface operations { description?: string | ""; effective_date?: "current_period_end" | number | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; trial_period_days?: number | ""; }; @@ -49532,7 +50494,7 @@ export interface operations { item_type?: "card_bin" | "card_fingerprint" | "case_sensitive_string" | "country" | "customer_id" | "email" | "ip_address" | "sepa_debit_fingerprint" | "string" | "us_bank_account_fingerprint"; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The human-readable name of the value list. */ name: string; @@ -49616,7 +50578,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The human-readable name of the value list. */ name?: string; @@ -49766,7 +50728,7 @@ export interface operations { instructions_email?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * @description Origin of the refund @@ -49862,7 +50824,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -50494,7 +51456,7 @@ export interface operations { } | ""; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The Stripe account ID created for this SetupIntent. */ on_behalf_of?: string; @@ -50595,7 +51557,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -50739,6 +51701,10 @@ export interface operations { us_bank_account?: { /** linked_account_options_param */ financial_connections?: { + /** linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; @@ -50869,9 +51835,9 @@ export interface operations { flow_directions?: ("inbound" | "outbound")[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. */ + /** @description ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string. */ payment_method?: string; /** @description The ID of the payment method configuration to use with this SetupIntent. */ payment_method_configuration?: string; @@ -50968,7 +51934,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -51112,6 +52078,10 @@ export interface operations { us_bank_account?: { /** linked_account_options_param */ financial_connections?: { + /** linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; @@ -51340,7 +52310,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -51484,6 +52454,10 @@ export interface operations { us_bank_account?: { /** linked_account_options_param */ financial_connections?: { + /** linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; @@ -51683,12 +52657,12 @@ export interface operations { amount: number; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - } | undefined; + }; }; }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -51790,12 +52764,12 @@ export interface operations { amount?: number; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - } | undefined; + }; }; }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * @description Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @@ -51975,7 +52949,7 @@ export interface operations { notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; }; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The source to share. */ original_source?: string; @@ -52167,7 +53141,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** * owner @@ -52494,7 +53468,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -52632,9 +53606,9 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ + /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; /** * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -53007,7 +53981,7 @@ export interface operations { from_subscription?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: { @@ -53083,7 +54057,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -53107,7 +54081,7 @@ export interface operations { }[]; iterations?: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; /** @enum {string} */ @@ -53249,7 +54223,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: { @@ -53323,7 +54297,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -53347,7 +54321,7 @@ export interface operations { }[]; iterations?: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; on_behalf_of?: string; /** @enum {string} */ @@ -53635,7 +54609,7 @@ export interface operations { * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ cancel_at?: number; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ + /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. @@ -53690,7 +54664,7 @@ export interface operations { promotion_code?: string; }[] | ""; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; price?: string; /** recurring_price_data */ @@ -53714,9 +54688,9 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ + /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; /** @description The account on behalf of which to charge, for each of the subscription's invoices. */ on_behalf_of?: string | ""; @@ -53784,6 +54758,10 @@ export interface operations { us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { + /** invoice_linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; }; @@ -53791,7 +54769,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -54009,7 +54987,7 @@ export interface operations { } | ""; /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ cancel_at?: number | ""; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ + /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** * cancellation_details_param @@ -54072,7 +55050,7 @@ export interface operations { }[] | ""; id?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; price?: string; /** recurring_price_data */ @@ -54096,9 +55074,9 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; - /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ + /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ off_session?: boolean; /** @description The account on behalf of which to charge, for each of the subscription's invoices. */ on_behalf_of?: string | ""; @@ -54169,6 +55147,10 @@ export interface operations { us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { + /** invoice_linked_account_options_filters_param */ + filters?: { + account_subcategories?: ("checking" | "savings")[]; + }; permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; prefetch?: ("balances" | "ownership" | "transactions")[]; }; @@ -54176,7 +55158,7 @@ export interface operations { verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "multibanco" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -54414,7 +55396,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @enum {string} */ @@ -55266,8 +56248,13 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; + /** + * Format: unix-time + * @description The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time. + */ + posted_at?: number; /** @description A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals. */ reference: string; }; @@ -55313,7 +56300,7 @@ export interface operations { amount: number; amount_tax: number; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; original_line_item: string; quantity?: number; @@ -55321,7 +56308,7 @@ export interface operations { }[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * @description If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed. @@ -55633,10 +56620,10 @@ export interface operations { type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -55826,7 +56813,7 @@ export interface operations { jurisdiction?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description This represents the tax rate percent out of 100. */ percentage: number; @@ -55925,7 +56912,7 @@ export interface operations { jurisdiction?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. */ state?: string; @@ -56038,6 +57025,14 @@ export interface operations { offline?: { enabled: boolean; } | ""; + /** + * reboot_window + * @description Reboot time settings for readers that support customized reboot time configuration. + */ + reboot_window?: { + end_hour: number; + start_hour: number; + }; /** * stripe_s700 * @description An object containing device type specific settings for Stripe S700 readers @@ -56225,6 +57220,11 @@ export interface operations { offline?: { enabled: boolean; } | ""; + /** @description Reboot time settings for readers that support customized reboot time configuration. */ + reboot_window?: { + end_hour: number; + start_hour: number; + } | ""; /** @description An object containing device type specific settings for Stripe S700 readers */ stripe_s700?: { splashscreen?: string | ""; @@ -56500,7 +57500,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -56596,7 +57596,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -56661,7 +57661,7 @@ export interface operations { parameters: { query?: { /** @description Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; + device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "verifone_P400"; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -56737,7 +57737,7 @@ export interface operations { location?: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description A code generated by the reader used for registering to an account. */ registration_code: string; @@ -56821,7 +57821,7 @@ export interface operations { label?: string | ""; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -57041,7 +58041,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description ID of the PaymentIntent to refund. */ payment_intent?: string; @@ -57243,7 +58243,7 @@ export interface operations { /** param */ link?: Record; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** param */ mobilepay?: Record; @@ -57425,6 +58425,59 @@ export interface operations { currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * fleet_testmode_authorization_specs + * @description Fleet-specific information for authorizations using Fleet cards. + */ + fleet?: { + /** fleet_cardholder_prompt_data_specs */ + cardholder_prompt_data?: { + driver_id?: string; + odometer?: number; + unspecified_id?: string; + user_id?: string; + vehicle_number?: string; + }; + /** @enum {string} */ + purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase"; + /** fleet_reported_breakdown_specs */ + reported_breakdown?: { + /** fleet_reported_breakdown_fuel_specs */ + fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_non_fuel_specs */ + non_fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_tax_specs */ + tax?: { + /** Format: decimal */ + local_amount_decimal?: string; + /** Format: decimal */ + national_amount_decimal?: string; + }; + }; + /** @enum {string} */ + service_type?: "full_service" | "non_fuel_transaction" | "self_service"; + }; + /** + * fuel_specs + * @description Information about fuel that was purchased with this transaction. + */ + fuel?: { + industry_product_code?: string; + /** Format: decimal */ + quantity_decimal?: string; + /** @enum {string} */ + type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; + /** @enum {string} */ + unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; + /** Format: decimal */ + unit_cost_decimal?: string; + }; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ is_amount_controllable?: boolean; /** @@ -57528,6 +58581,41 @@ export interface operations { * @description Additional purchase information that is optionally provided by the merchant. */ purchase_details?: { + /** fleet_specs */ + fleet?: { + /** fleet_cardholder_prompt_data_specs */ + cardholder_prompt_data?: { + driver_id?: string; + odometer?: number; + unspecified_id?: string; + user_id?: string; + vehicle_number?: string; + }; + /** @enum {string} */ + purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase"; + /** fleet_reported_breakdown_specs */ + reported_breakdown?: { + /** fleet_reported_breakdown_fuel_specs */ + fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_non_fuel_specs */ + non_fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_tax_specs */ + tax?: { + /** Format: decimal */ + local_amount_decimal?: string; + /** Format: decimal */ + national_amount_decimal?: string; + }; + }; + /** @enum {string} */ + service_type?: "full_service" | "non_fuel_transaction" | "self_service"; + }; /** flight_specs */ flight?: { /** Format: unix-time */ @@ -57546,6 +58634,7 @@ export interface operations { }; /** fuel_specs */ fuel?: { + industry_product_code?: string; /** Format: decimal */ quantity_decimal?: string; /** @enum {string} */ @@ -57632,6 +58721,99 @@ export interface operations { }; }; }; + PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount: { + parameters: { + query?: never; + header?: never; + path: { + authorization: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + final_amount: number; + /** + * fleet_specs + * @description Fleet-specific information for authorizations using Fleet cards. + */ + fleet?: { + /** fleet_cardholder_prompt_data_specs */ + cardholder_prompt_data?: { + driver_id?: string; + odometer?: number; + unspecified_id?: string; + user_id?: string; + vehicle_number?: string; + }; + /** @enum {string} */ + purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase"; + /** fleet_reported_breakdown_specs */ + reported_breakdown?: { + /** fleet_reported_breakdown_fuel_specs */ + fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_non_fuel_specs */ + non_fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_tax_specs */ + tax?: { + /** Format: decimal */ + local_amount_decimal?: string; + /** Format: decimal */ + national_amount_decimal?: string; + }; + }; + /** @enum {string} */ + service_type?: "full_service" | "non_fuel_transaction" | "self_service"; + }; + /** + * fuel_specs + * @description Information about fuel that was purchased with this transaction. + */ + fuel?: { + industry_product_code?: string; + /** Format: decimal */ + quantity_decimal?: string; + /** @enum {string} */ + type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; + /** @enum {string} */ + unit?: "charging_minute" | "imperial_gallon" | "kilogram" | "kilowatt_hour" | "liter" | "other" | "pound" | "us_gallon"; + /** Format: decimal */ + unit_cost_decimal?: string; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.authorization"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTestHelpersIssuingAuthorizationsAuthorizationIncrement: { parameters: { query?: never; @@ -58027,6 +59209,41 @@ export interface operations { * @description Additional purchase information that is optionally provided by the merchant. */ purchase_details?: { + /** fleet_specs */ + fleet?: { + /** fleet_cardholder_prompt_data_specs */ + cardholder_prompt_data?: { + driver_id?: string; + odometer?: number; + unspecified_id?: string; + user_id?: string; + vehicle_number?: string; + }; + /** @enum {string} */ + purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase"; + /** fleet_reported_breakdown_specs */ + reported_breakdown?: { + /** fleet_reported_breakdown_fuel_specs */ + fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_non_fuel_specs */ + non_fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_tax_specs */ + tax?: { + /** Format: decimal */ + local_amount_decimal?: string; + /** Format: decimal */ + national_amount_decimal?: string; + }; + }; + /** @enum {string} */ + service_type?: "full_service" | "non_fuel_transaction" | "self_service"; + }; /** flight_specs */ flight?: { /** Format: unix-time */ @@ -58045,6 +59262,7 @@ export interface operations { }; /** fuel_specs */ fuel?: { + industry_product_code?: string; /** Format: decimal */ quantity_decimal?: string; /** @enum {string} */ @@ -58132,6 +59350,41 @@ export interface operations { * @description Additional purchase information that is optionally provided by the merchant. */ purchase_details?: { + /** fleet_specs */ + fleet?: { + /** fleet_cardholder_prompt_data_specs */ + cardholder_prompt_data?: { + driver_id?: string; + odometer?: number; + unspecified_id?: string; + user_id?: string; + vehicle_number?: string; + }; + /** @enum {string} */ + purchase_type?: "fuel_and_non_fuel_purchase" | "fuel_purchase" | "non_fuel_purchase"; + /** fleet_reported_breakdown_specs */ + reported_breakdown?: { + /** fleet_reported_breakdown_fuel_specs */ + fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_non_fuel_specs */ + non_fuel?: { + /** Format: decimal */ + gross_amount_decimal?: string; + }; + /** fleet_reported_breakdown_tax_specs */ + tax?: { + /** Format: decimal */ + local_amount_decimal?: string; + /** Format: decimal */ + national_amount_decimal?: string; + }; + }; + /** @enum {string} */ + service_type?: "full_service" | "non_fuel_transaction" | "self_service"; + }; /** flight_specs */ flight?: { /** Format: unix-time */ @@ -58150,6 +59403,7 @@ export interface operations { }; /** fuel_specs */ fuel?: { + industry_product_code?: string; /** Format: decimal */ quantity_decimal?: string; /** @enum {string} */ @@ -59278,7 +60532,7 @@ export interface operations { last_name_kanji?: string; maiden_name?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; phone?: string; /** @enum {string} */ @@ -59441,7 +60695,7 @@ export interface operations { last_name_kanji?: string; maiden_name?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; nationality?: string; phone?: string; @@ -59638,7 +60892,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ source?: string; @@ -59726,7 +60980,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -59877,7 +61131,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details. */ source_transaction?: string; @@ -59988,7 +61242,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed. */ refund_application_fee?: boolean; @@ -60072,7 +61326,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -60154,7 +61408,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; }; }; @@ -60254,7 +61508,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The ReceivedCredit to reverse. */ received_credit: string; @@ -60396,7 +61650,7 @@ export interface operations { expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The ReceivedDebit to reverse. */ received_debit: string; @@ -60590,7 +61844,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * platform_restrictions @@ -60736,7 +61990,7 @@ export interface operations { }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** * platform_restrictions @@ -60997,7 +62251,7 @@ export interface operations { financial_account: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The origin payment method to be debited for the InboundTransfer. */ origin_payment_method: string; @@ -61211,7 +62465,7 @@ export interface operations { }; financial_account?: string; metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @enum {string} */ type: "financial_account" | "us_bank_account"; @@ -61250,7 +62504,7 @@ export interface operations { financial_account: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment". */ statement_descriptor?: string; @@ -61446,7 +62700,7 @@ export interface operations { financial_account: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; }; /** @description Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". */ statement_descriptor?: string; @@ -62045,12 +63299,12 @@ export interface operations { /** @description An optional description of what the webhook is used for. */ description?: string | ""; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing.alert.triggered" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.funds_rescinded" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The URL of the webhook endpoint. */ url: string; @@ -62133,12 +63387,12 @@ export interface operations { /** @description Disable the webhook endpoint if set to true. */ disabled?: boolean; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing.alert.triggered" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.funds_rescinded" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_personalization_design.activated" | "issuing_personalization_design.deactivated" | "issuing_personalization_design.rejected" | "issuing_personalization_design.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_payment.tracking_details_updated" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.outbound_transfer.tracking_details_updated" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { - [key: string]: string | undefined; + [key: string]: string; } | ""; /** @description The URL of the webhook endpoint. */ url?: string; diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index 3865b9968..801777c8a 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -206,7 +206,7 @@ components: amount: description: >- A non-negative integer representing the amount in the [smallest - currency unit](https://docs.stripe.com/currencies#zero-decimal). + currency unit](/currencies#zero-decimal). nullable: true type: integer currency: @@ -320,9 +320,9 @@ components: type: integer mcc: description: >- - [The merchant category code for the - account](https://stripe.com/docs/connect/setting-mcc). MCCs are used - to classify businesses based on the goods or services they provide. + [The merchant category code for the account](/connect/setting-mcc). + MCCs are used to classify businesses based on the goods or services + they provide. maxLength: 5000 nullable: true type: string @@ -847,11 +847,21 @@ components: type: array disabled_reason: description: >- - This is typed as a string for consistency with + This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume - `future_requirements.disabled_reason` is empty because fields in + `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. - maxLength: 5000 + enum: + - other + - paused.inactivity + - pending.onboarding + - pending.review + - platform_disabled + - platform_paused + - rejected.inactivity + - rejected.other + - rejected.unsupported_business + - requirements.fields_needed nullable: true type: string errors: @@ -935,27 +945,20 @@ components: type: array disabled_reason: description: >- - If the capability is disabled, this string describes why. [Learn - more about handling verification + Description of why the capability is disabled. [Learn more about + handling verification issues](https://stripe.com/docs/connect/handling-api-verification). - Can be `requirements.fields_needed`, `pending.onboarding`, - `pending.review`, `rejected.other`, `platform_paused`, - `rejected.inactivty`, or `rejected.unsupported_business`. - - - `rejected.unsupported_business` means that the account's business is - not supported by the capability. For example, payment methods may - restrict the businesses they support in their terms of service, such - as in [Afterpay Clearpay's terms of - service](/afterpay-clearpay/legal#restricted-businesses). - - - `rejected.inactivity` means that the capability has been paused for - inactivity. This disabled reason currently only applies to the - Issuing capability. See [Issuing: Managing Inactive - Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) - for more details. - maxLength: 5000 + enum: + - other + - paused.inactivity + - pending.onboarding + - pending.review + - platform_disabled + - platform_paused + - rejected.inactivity + - rejected.other + - rejected.unsupported_business + - requirements.fields_needed nullable: true type: string errors: @@ -1250,8 +1253,7 @@ components: amount: description: >- A non-negative integer representing how much to charge in the - [smallest currency - unit](https://docs.stripe.com/currencies#zero-decimal). + [smallest currency unit](/currencies#zero-decimal). type: integer currency: description: >- @@ -2972,7 +2974,9 @@ components: additionalProperties: type: integer description: >- - The balances owed to (or by) the account holder. + The balances owed to (or by) the account holder, before subtracting + any outbound pending transactions or adding any inbound pending + transactions. Each key is a three-letter [ISO currency @@ -3009,7 +3013,8 @@ components: type: integer description: >- The funds available to the account holder. Typically this is the - current balance less any holds. + current balance after subtracting any outbound pending transactions + and adding any inbound pending transactions. Each key is a three-letter [ISO currency @@ -3081,6 +3086,21 @@ components: bank_connections_resource_link_account_session_filters: description: '' properties: + account_subcategories: + description: >- + Restricts the Session to subcategories of accounts that can be + linked. Valid subcategories are: `checking`, `savings`, `mortgage`, + `line_of_credit`, `credit_card`. + items: + enum: + - checking + - credit_card + - line_of_credit + - mortgage + - savings + type: string + nullable: true + type: array countries: description: List of countries from which to filter accounts. items: @@ -3401,7 +3421,9 @@ components: meter via `default_aggregation`. type: number end_time: - description: End timestamp for this event summary (inclusive). + description: >- + End timestamp for this event summary (exclusive). Must be aligned + with minute boundaries. format: unix-time type: integer id: @@ -3425,7 +3447,9 @@ components: - billing.meter_event_summary type: string start_time: - description: Start timestamp for this event summary (inclusive). + description: >- + Start timestamp for this event summary (inclusive). Must be aligned + with minute boundaries. format: unix-time type: integer required: @@ -3668,8 +3692,7 @@ components: and billing details. - Learn more in the [integration - guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). + Related guide: [Customer management](/customer-management) properties: configuration: anyOf: @@ -4336,7 +4359,8 @@ components: The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks - like after the static and dynamic portions are combined. + like after the static and dynamic portions are combined. This only + works for card payments. maxLength: 5000 nullable: true type: string @@ -4922,7 +4946,8 @@ components: - $ref: >- #/components/schemas/payment_pages_checkout_session_currency_conversion description: >- - Currency conversion details for automatic currency conversion + Currency conversion details for [Adaptive + Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions nullable: true custom_fields: @@ -5463,6 +5488,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5502,6 +5534,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5530,6 +5569,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5558,6 +5604,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5586,6 +5639,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5615,6 +5675,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5643,6 +5710,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5673,6 +5747,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5708,6 +5789,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5769,6 +5857,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5823,6 +5918,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5907,6 +6009,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5936,6 +6045,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5964,6 +6080,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -5992,6 +6115,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6020,6 +6150,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6048,6 +6185,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6076,6 +6220,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6114,6 +6265,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6142,6 +6300,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6171,6 +6336,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6199,6 +6371,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6234,6 +6413,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6264,6 +6450,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6292,6 +6485,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6343,6 +6543,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6382,6 +6589,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6411,6 +6625,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6545,6 +6766,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -6588,6 +6816,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -7065,6 +7300,12 @@ components: maxLength: 5000 nullable: true type: string + payment_method_options: + anyOf: + - $ref: >- + #/components/schemas/confirmation_tokens_resource_payment_method_options + description: Payment-method-specific configuration for this ConfirmationToken. + nullable: true payment_method_preview: anyOf: - $ref: >- @@ -7121,6 +7362,7 @@ components: type: object x-expandableFields: - mandate_data + - payment_method_options - payment_method_preview - shipping x-resourceId: confirmation_token @@ -7178,6 +7420,30 @@ components: ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline type: object x-expandableFields: [] + confirmation_tokens_resource_payment_method_options: + description: Payment-method-specific configuration + properties: + card: + anyOf: + - $ref: >- + #/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card + description: This hash contains the card payment method options. + nullable: true + title: ConfirmationTokensResourcePaymentMethodOptions + type: object + x-expandableFields: + - card + confirmation_tokens_resource_payment_method_options_resource_card: + description: This hash contains the card payment method options. + properties: + cvc_token: + description: The `cvc_update` Token collected from the Payment Element. + maxLength: 5000 + nullable: true + type: string + title: ConfirmationTokensResourcePaymentMethodOptionsResourceCard + type: object + x-expandableFields: [] confirmation_tokens_resource_payment_method_preview: description: Details of the PaymentMethod collected by Payment Element properties: @@ -7221,6 +7487,19 @@ components: $ref: '#/components/schemas/payment_method_card_present' cashapp: $ref: '#/components/schemas/payment_method_cashapp' + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + description: >- + The ID of the Customer to which this PaymentMethod is saved. This + will not be set when the PaymentMethod has not been saved to a + Customer. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' customer_balance: $ref: '#/components/schemas/payment_method_customer_balance' eps: @@ -7340,6 +7619,7 @@ components: - card - card_present - cashapp + - customer - customer_balance - eps - fpx @@ -7512,6 +7792,10 @@ components: $ref: '#/components/schemas/connect_embedded_payouts_config_claim' payouts_list: $ref: '#/components/schemas/connect_embedded_base_config_claim' + tax_registrations: + $ref: '#/components/schemas/connect_embedded_base_config_claim' + tax_settings: + $ref: '#/components/schemas/connect_embedded_base_config_claim' required: - account_management - account_onboarding @@ -7522,6 +7806,8 @@ components: - payments - payouts - payouts_list + - tax_registrations + - tax_settings title: ConnectEmbeddedAccountSessionCreateComponents type: object x-expandableFields: @@ -7534,6 +7820,8 @@ components: - payments - payouts - payouts_list + - tax_registrations + - tax_settings connect_embedded_base_config_claim: description: '' properties: @@ -8597,7 +8885,9 @@ components: next_invoice_sequence: description: >- The suffix of the customer's next invoice number (for example, - 0001). + 0001). When the account uses account level sequencing, this + parameter is ignored in API requests and the field omitted in API + responses. type: integer object: description: >- @@ -9358,14 +9648,14 @@ components: x-resourceId: customer_cash_balance_transaction customer_session: description: >- - A customer session allows you to grant client access to Stripe's - frontend SDKs (like StripeJs) + A Customer Session allows you to grant Stripe's frontend SDKs (like + Stripe.js) client-side access - control over a customer. + control over a Customer. properties: client_secret: description: >- - The client secret of this customer session. Used on the client to + The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`. @@ -9388,12 +9678,12 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - description: The customer the customer session was created for. + description: The Customer the Customer Session was created for. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' expires_at: - description: The timestamp at which this customer session will expire. + description: The timestamp at which this Customer Session will expire. format: unix-time type: integer livemode: @@ -9422,21 +9712,26 @@ components: - customer x-resourceId: customer_session customer_session_resource_components: - description: Configuration for the components supported by this customer session. + description: Configuration for the components supported by this Customer Session. properties: buy_button: $ref: >- #/components/schemas/customer_session_resource_components_resource_buy_button + payment_element: + $ref: >- + #/components/schemas/customer_session_resource_components_resource_payment_element pricing_table: $ref: >- #/components/schemas/customer_session_resource_components_resource_pricing_table required: - buy_button + - payment_element - pricing_table title: CustomerSessionResourceComponents type: object x-expandableFields: - buy_button + - payment_element - pricing_table customer_session_resource_components_resource_buy_button: description: This hash contains whether the buy button is enabled. @@ -9449,6 +9744,123 @@ components: title: CustomerSessionResourceComponentsResourceBuyButton type: object x-expandableFields: [] + customer_session_resource_components_resource_payment_element: + description: >- + This hash contains whether the Payment Element is enabled and the + features it supports. + properties: + enabled: + description: Whether the Payment Element is enabled. + type: boolean + features: + anyOf: + - $ref: >- + #/components/schemas/customer_session_resource_components_resource_payment_element_resource_features + description: >- + This hash defines whether the Payment Element supports certain + features. + nullable: true + required: + - enabled + title: CustomerSessionResourceComponentsResourcePaymentElement + type: object + x-expandableFields: + - features + customer_session_resource_components_resource_payment_element_resource_features: + description: This hash contains the features the Payment Element supports. + properties: + payment_method_allow_redisplay_filters: + description: >- + A list of + [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) + values that controls which saved payment methods the Payment Element + displays by filtering to only show payment methods with an + `allow_redisplay` value that is present in this list. + + + If not specified, defaults to ["always"]. In order to display all + saved payment methods, specify ["always", "limited", "unspecified"]. + items: + enum: + - always + - limited + - unspecified + type: string + type: array + payment_method_redisplay: + description: >- + Controls whether or not the Payment Element shows saved payment + methods. This parameter defaults to `disabled`. + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_redisplay_limit: + description: >- + Determines the max number of saved payment methods for the Payment + Element to display. This parameter defaults to `10`. + nullable: true + type: integer + payment_method_remove: + description: >- + Controls whether the Payment Element displays the option to remove a + saved payment method. This parameter defaults to `disabled`. + + + Allowing buyers to remove their saved payment methods impacts + subscriptions that depend on that payment method. Removing the + payment method detaches the [`customer` + object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) + from that + [PaymentMethod](https://docs.stripe.com/api/payment_methods). + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_save: + description: >- + Controls whether the Payment Element displays a checkbox offering to + save a new payment method. This parameter defaults to `disabled`. + + + If a customer checks the box, the + [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) + value on the PaymentMethod is set to `'always'` at confirmation + time. For PaymentIntents, the + [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) + value is also set to the value defined in + `payment_method_save_usage`. + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_save_usage: + description: >- + When using PaymentIntents and the customer checks the save checkbox, + this field determines the + [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) + value used to confirm the PaymentIntent. + + + When using SetupIntents, directly configure the + [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) + value on SetupIntent creation. + enum: + - off_session + - on_session + nullable: true + type: string + required: + - payment_method_allow_redisplay_filters + - payment_method_redisplay + - payment_method_remove + - payment_method_save + title: CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures + type: object + x-expandableFields: [] customer_session_resource_components_resource_pricing_table: description: This hash contains whether the pricing table is enabled. properties: @@ -10919,6 +11331,15 @@ components: `mastercard`, `unionpay`, `visa`, or `unknown`. maxLength: 5000 type: string + case_type: + description: >- + The type of dispute opened. Different case types may have varying + fees and financial impact. + enum: + - chargeback + - inquiry + type: string + x-stripeBypassValidation: true network_reason_code: description: >- The card network's specific dispute reason code, which maps to one @@ -10931,6 +11352,7 @@ components: type: string required: - brand + - case_type title: DisputePaymentMethodDetailsCard type: object x-expandableFields: [] @@ -13495,7 +13917,7 @@ components: API. - Related guides: [Accessing verification + Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). properties: client_reference_id: @@ -14941,6 +15363,9 @@ components: invoice_payment_method_options_us_bank_account_linked_account_options: description: '' properties: + filters: + $ref: >- + #/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters permissions: description: >- The list of permissions to request. The `payment_method` permission @@ -14966,6 +15391,24 @@ components: type: array title: invoice_payment_method_options_us_bank_account_linked_account_options type: object + x-expandableFields: + - filters + invoice_payment_method_options_us_bank_account_linked_account_options_filters: + description: '' + properties: + account_subcategories: + description: >- + The account subcategories to use to filter for possible accounts to + link. Valid subcategories are `checking` and `savings`. + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_payment_method_options_us_bank_account_linked_account_options_filters + type: object x-expandableFields: [] invoice_rendering_pdf: description: '' @@ -15594,6 +16037,7 @@ components: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -15671,7 +16115,7 @@ components: `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, - `de_stn`, or `unknown` + `de_stn`, `ch_uid`, or `unknown` enum: - ad_nrt - ae_trn @@ -15689,6 +16133,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -15929,6 +16374,19 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_data' + description: Fleet-specific information for authorizations using Fleet cards. + nullable: true + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fuel_data' + description: >- + Information about fuel that was purchased with this transaction. + Typically this information is received from the merchant after the + authorization has been approved and the fuel dispensed. + nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -16072,6 +16530,8 @@ components: - balance_transactions - card - cardholder + - fleet + - fuel - merchant_data - network_data - pending_request @@ -17153,6 +17613,212 @@ components: title: IssuingAuthorizationAuthenticationExemption type: object x-expandableFields: [] + issuing_authorization_fleet_cardholder_prompt_data: + description: '' + properties: + alphanumeric_id: + description: >- + [Deprecated] An alphanumeric ID, though typical point of sales only + support numeric entry. The card program can be configured to prompt + for a vehicle ID, driver ID, or generic ID. + maxLength: 5000 + nullable: true + type: string + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + description: >- + An alphanumeric ID. This field is used when a vehicle ID, driver ID, + or generic ID is entered by the cardholder, but the merchant or card + network did not specify the prompt type. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + title: IssuingAuthorizationFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_authorization_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_cardholder_prompt_data + description: >- + Answers to prompts presented to the cardholder at the point of sale. + Prompted fields vary depending on the configuration of your physical + fleet cards. Typical points of sale support only numeric entry. + nullable: true + purchase_type: + description: The type of purchase. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_reported_breakdown + description: >- + More information about the total amount. Typically this information + is received from the merchant after the authorization has been + approved and the fuel dispensed. This information is not guaranteed + to be accurate as some merchants may provide unreliable data. + nullable: true + service_type: + description: The type of fuel service. + enum: + - full_service + - non_fuel_transaction + - self_service + nullable: true + type: string + title: IssuingAuthorizationFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_authorization_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Quantity multiplied by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + title: IssuingAuthorizationFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_authorization_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + Amount of state or provincial Sales Tax included in the transaction + amount. `null` if not reported by merchant or not subject to tax. + format: decimal + nullable: true + type: string + national_amount_decimal: + description: >- + Amount of national Sales Tax or VAT included in the transaction + amount. `null` if not reported by merchant or not subject to tax. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFleetTaxData + type: object + x-expandableFields: [] + issuing_authorization_fuel_data: + description: '' + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, represented as a + decimal string with at most 12 decimal places. + format: decimal + nullable: true + type: string + type: + description: The type of fuel that was purchased. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + nullable: true + type: string + unit: + description: The units for `quantity_decimal`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + nullable: true + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as a decimal + string with at most 12 decimal places. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFuelData + type: object + x-expandableFields: [] issuing_authorization_merchant_data: description: '' properties: @@ -17378,11 +18044,16 @@ components: enum: - account_disabled - card_active + - card_canceled + - card_expired - card_inactive + - cardholder_blocked - cardholder_inactive - cardholder_verification_required + - insecure_authorization_method - insufficient_funds - not_allowed + - pin_blocked - spending_controls - suspected_fraud - verification_failed @@ -18245,6 +18916,11 @@ components: properties: address: $ref: '#/components/schemas/address' + address_validation: + anyOf: + - $ref: '#/components/schemas/issuing_card_shipping_address_validation' + description: Address validation details for the shipment. + nullable: true carrier: description: The delivery company that shipped a card. enum: @@ -18335,7 +19011,37 @@ components: type: object x-expandableFields: - address + - address_validation - customs + issuing_card_shipping_address_validation: + description: '' + properties: + mode: + description: The address validation capabilities to use. + enum: + - disabled + - normalization_only + - validation_and_normalization + type: string + normalized_address: + anyOf: + - $ref: '#/components/schemas/address' + description: The normalized shipping address. + nullable: true + result: + description: The validation result for the shipping address. + enum: + - indeterminate + - likely_deliverable + - likely_undeliverable + nullable: true + type: string + required: + - mode + title: IssuingCardShippingAddressValidation + type: object + x-expandableFields: + - normalized_address issuing_card_shipping_customs: description: '' properties: @@ -20693,6 +21399,147 @@ components: title: IssuingTransactionAmountDetails type: object x-expandableFields: [] + issuing_transaction_fleet_cardholder_prompt_data: + description: '' + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + description: >- + An alphanumeric ID. This field is used when a vehicle ID, driver ID, + or generic ID is entered by the cardholder, but the merchant or card + network did not specify the prompt type. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + title: IssuingTransactionFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_transaction_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_cardholder_prompt_data + description: Answers to prompts presented to cardholder at point of sale. + nullable: true + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, + or `fuel_and_non_fuel_purchase`. + maxLength: 5000 + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_reported_breakdown + description: >- + More information about the total amount. This information is not + guaranteed to be accurate as some merchants may provide unreliable + data. + nullable: true + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + maxLength: 5000 + nullable: true + type: string + title: IssuingTransactionFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_transaction_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume multipled by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingTransactionFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingTransactionFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + title: IssuingTransactionFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_transaction_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + Amount of state or provincial Sales Tax included in the transaction + amount. Null if not reported by merchant or not subject to tax. + format: decimal + nullable: true + type: string + national_amount_decimal: + description: >- + Amount of national Sales Tax or VAT included in the transaction + amount. Null if not reported by merchant or not subject to tax. + format: decimal + nullable: true + type: string + title: IssuingTransactionFleetTaxData + type: object + x-expandableFields: [] issuing_transaction_flight_data: description: '' properties: @@ -20762,6 +21609,14 @@ components: issuing_transaction_fuel_data: description: '' properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, represented as a @@ -20845,6 +21700,11 @@ components: issuing_transaction_purchase_details: description: '' properties: + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_data' + description: Fleet-specific information for transactions using Fleet cards. + nullable: true flight: anyOf: - $ref: '#/components/schemas/issuing_transaction_flight_data' @@ -20876,6 +21736,7 @@ components: title: IssuingTransactionPurchaseDetails type: object x-expandableFields: + - fleet - flight - fuel - lodging @@ -21643,6 +22504,9 @@ components: linked_account_options_us_bank_account: description: '' properties: + filters: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters permissions: description: >- The list of permissions to request. The `payment_method` permission @@ -21675,7 +22539,8 @@ components: type: string title: linked_account_options_us_bank_account type: object - x-expandableFields: [] + x-expandableFields: + - filters login_link: description: >- Login Links are single-use URLs for a connected account to access the @@ -22534,6 +23399,23 @@ components: title: PaymentFlowsPrivatePaymentMethodsKlarnaDOB type: object x-expandableFields: [] + payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters: + description: '' + properties: + account_subcategories: + description: >- + The account subcategories to use to filter for possible accounts to + link. Valid subcategories are `checking` and `savings`. + items: + enum: + - checking + - savings + type: string + type: array + title: >- + PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters + type: object + x-expandableFields: [] payment_intent: description: >- A PaymentIntent guides you through the process of collecting a payment @@ -22694,11 +23576,16 @@ components: PaymentIntent. - If present in combination with - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), - this PaymentIntent's payment method will be attached to the Customer + If + [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + is set and this PaymentIntent's payment method is not + `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions - from the user are complete. + from the user are complete. If the payment method is `card_present` + and isn't a digital wallet, then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. nullable: true x-expansionResources: oneOf: @@ -22738,7 +23625,11 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/charge' - description: The latest charge created by this PaymentIntent. + description: >- + ID of the latest [Charge + object](https://stripe.com/docs/api/charges) created by this + PaymentIntent. This property is `null` until PaymentIntent + confirmation is attempted. nullable: true x-expansionResources: oneOf: @@ -22860,6 +23751,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -23943,6 +24841,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -23982,6 +24887,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24012,6 +24924,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24146,6 +25065,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24199,6 +25125,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24234,6 +25167,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24308,6 +25248,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24339,6 +25286,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24377,6 +25331,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24416,6 +25377,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24489,6 +25457,17 @@ components: type: string installments: $ref: '#/components/schemas/payment_flows_installment_options' + request_incremental_authorization_support: + description: >- + Request ability to + [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) + this PaymentIntent if the combination of MCC and card brand is + eligible. Check + [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + in the + [Confirm](https://stripe.com/docs/api/payment_intents/confirm) + response to verify support. + type: boolean require_cvc_recollection: description: >- When enabled, using a card that is attached to a customer will @@ -24512,6 +25491,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -24751,6 +25737,7 @@ components: - konbini - link - mobilepay + - multibanco - oxxo - p24 - paynow @@ -24760,8 +25747,10 @@ components: - sepa_debit - sofort - swish + - twint - us_bank_account - wechat_pay + - zip type: string x-stripeBypassValidation: true nullable: true @@ -26280,6 +27269,13 @@ components: maxLength: 5000 nullable: true type: string + brand_product: + description: >- + The [product code](https://stripe.com/docs/card-product-codes) that + identifies the specific program or product associated with a card. + maxLength: 5000 + nullable: true + type: string cardholder_name: description: >- The cardholder name as read from the card, in [ISO @@ -26300,6 +27296,11 @@ components: maxLength: 5000 nullable: true type: string + description: + description: A high-level description of the type of cards issued in this range. + maxLength: 5000 + nullable: true + type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer @@ -26329,6 +27330,11 @@ components: maxLength: 5000 nullable: true type: string + issuer: + description: The name of the card's issuing bank. + maxLength: 5000 + nullable: true + type: string last4: description: The last four digits of the card. maxLength: 5000 @@ -26821,6 +27827,9 @@ components: swish: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + twint: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties us_bank_account: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -26876,6 +27885,7 @@ components: - sepa_debit - sofort - swish + - twint - us_bank_account - wechat_pay - zip @@ -27147,7 +28157,12 @@ components: x-expandableFields: [] payment_method_details_affirm: description: '' - properties: {} + properties: + transaction_id: + description: The Affirm transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_affirm type: object x-expandableFields: [] @@ -27305,7 +28320,12 @@ components: - generated_sepa_debit_mandate payment_method_details_blik: description: '' - properties: {} + properties: + buyer_id: + description: A unique and immutable identifier assigned by BLIK to every buyer. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_blik type: object x-expandableFields: [] @@ -27525,6 +28545,7 @@ components: enum: - fixed_count type: string + x-stripeBypassValidation: true required: - type title: payment_method_details_card_installments_plan @@ -27557,6 +28578,13 @@ components: maxLength: 5000 nullable: true type: string + brand_product: + description: >- + The [product code](https://stripe.com/docs/card-product-codes) that + identifies the specific program or product associated with a card. + maxLength: 5000 + nullable: true + type: string capture_before: description: >- When using manual capture, a future timestamp after which the charge @@ -27583,6 +28611,11 @@ components: maxLength: 5000 nullable: true type: string + description: + description: A high-level description of the type of cards issued in this range. + maxLength: 5000 + nullable: true + type: string emv_auth_data: description: Authorization response cryptogram. maxLength: 5000 @@ -27633,6 +28666,11 @@ components: eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). type: boolean + issuer: + description: The name of the card's issuing bank. + maxLength: 5000 + nullable: true + type: string last4: description: The last four digits of the card. maxLength: 5000 @@ -27646,6 +28684,22 @@ components: maxLength: 5000 nullable: true type: string + network_transaction_id: + description: >- + This is used by the financial networks to identify a transaction. + + Visa calls this the Transaction ID, Mastercard calls this the Trace + ID, and American Express calls this the Acquirer Reference Data. + + The first three digits of the Trace ID is the Financial Network + Code, the next 6 digits is the Banknet Reference Number, and the + last 4 digits represent the date (MM/DD). + + This field will be available for successful Visa, Mastercard, or + American Express transactions and always null for other card brands. + maxLength: 5000 + nullable: true + type: string offline: anyOf: - $ref: '#/components/schemas/payment_method_details_card_present_offline' @@ -28234,6 +29288,11 @@ components: maxLength: 5000 nullable: true type: string + description: + description: A high-level description of the type of cards issued in this range. + maxLength: 5000 + nullable: true + type: string emv_auth_data: description: Authorization response cryptogram. maxLength: 5000 @@ -28277,6 +29336,11 @@ components: maxLength: 5000 nullable: true type: string + issuer: + description: The name of the card's issuing bank. + maxLength: 5000 + nullable: true + type: string last4: description: The last four digits of the card. maxLength: 5000 @@ -28290,6 +29354,22 @@ components: maxLength: 5000 nullable: true type: string + network_transaction_id: + description: >- + This is used by the financial networks to identify a transaction. + + Visa calls this the Transaction ID, Mastercard calls this the Trace + ID, and American Express calls this the Acquirer Reference Data. + + The first three digits of the Trace ID is the Financial Network + Code, the next 6 digits is the Banknet Reference Number, and the + last 4 digits represent the date (MM/DD). + + This field will be available for successful Visa, Mastercard, or + American Express transactions and always null for other card brands. + maxLength: 5000 + nullable: true + type: string preferred_locales: description: >- EMV tag 5F2D. Preferred languages specified by the integrated @@ -28910,7 +29990,7 @@ components: certain payment methods are shown. - Related guides: [Payment method + Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). properties: apple_pay: @@ -29200,6 +30280,11 @@ components: maxLength: 5000 nullable: true type: string + description: + description: A high-level description of the type of cards issued in this range. + maxLength: 5000 + nullable: true + type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer @@ -29229,6 +30314,11 @@ components: maxLength: 5000 nullable: true type: string + issuer: + description: The name of the card's issuing bank. + maxLength: 5000 + nullable: true + type: string last4: description: The last four digits of the card. maxLength: 5000 @@ -29340,6 +30430,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29385,6 +30482,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29414,6 +30518,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29450,6 +30561,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29479,6 +30597,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29519,6 +30644,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29557,6 +30689,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29742,6 +30881,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29783,6 +30929,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29877,6 +31030,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29905,6 +31065,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29933,6 +31100,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -29961,6 +31135,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30010,6 +31191,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30068,6 +31256,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30096,6 +31291,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30131,6 +31333,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30161,6 +31370,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30189,6 +31405,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30240,6 +31463,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30279,6 +31509,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30307,6 +31544,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30342,6 +31586,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30385,6 +31636,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30414,6 +31672,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30470,6 +31735,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -30498,6 +31770,13 @@ components: Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital wallet, + then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as @@ -31722,7 +33001,7 @@ components: `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, - `de_stn`, or `unknown` + `de_stn`, `ch_uid`, or `unknown` enum: - ad_nrt - ae_trn @@ -31740,6 +33019,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -36836,7 +38116,12 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/payment_method' - description: ID of the payment method used with this SetupIntent. + description: >- + ID of the payment method used with this SetupIntent. If the payment + method is `card_present` and isn't a digital wallet, then the + [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) + associated with the `latest_attempt` is attached to the Customer + instead. nullable: true x-expansionResources: oneOf: @@ -37017,7 +38302,10 @@ components: - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client card: - $ref: '#/components/schemas/setup_intent_payment_method_options_card' + anyOf: + - $ref: '#/components/schemas/setup_intent_payment_method_options_card' + - $ref: >- + #/components/schemas/setup_intent_type_specific_payment_method_options_client card_present: anyOf: - $ref: >- @@ -38935,11 +40223,8 @@ components: type: integer cancel_at_period_end: description: >- - If the subscription has been canceled with the `at_period_end` flag - set to `true`, `cancel_at_period_end` on the subscription will be - true. You can use this attribute to determine whether a subscription - that has a status of active is scheduled to be canceled at the end - of the current period. + Whether this subscription will (if `status=active`) or did (if + `status=canceled`) cancel at the end of the current billing period. type: boolean canceled_at: description: >- @@ -40433,6 +41718,7 @@ components: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -40449,9 +41735,9 @@ components: type: array save_default_payment_method: description: >- - Either `off`, or `on_subscription`. With `on_subscription` Stripe - updates `subscription.default_payment_method` when a subscription - payment succeeds. + Configure whether Stripe updates + `subscription.default_payment_method` when payment succeeds. + Defaults to `off`. enum: - 'off' - on_subscription @@ -40580,7 +41866,9 @@ components: flow](https://stripe.com/docs/tax/custom) properties: amount_total: - description: Total after taxes. + description: >- + Total amount after taxes in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer currency: description: >- @@ -41018,6 +42306,12 @@ components: enum: - tax.transaction type: string + posted_at: + description: >- + The Unix timestamp representing when the tax liability is assumed or + reduced. + format: unix-time + type: integer reference: description: 'A custom unique identifier, such as ''myOrder_123''.' maxLength: 5000 @@ -41058,6 +42352,7 @@ components: - id - livemode - object + - posted_at - reference - tax_date - type @@ -41351,17 +42646,17 @@ components: Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, - `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, - `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, - `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, - `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, - `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, - `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, - `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, - `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, - `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, - `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type - `unknown` + `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, + `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, + `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, + `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, + `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, + `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, + `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, + `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, + `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have + type `unknown` enum: - ad_nrt - ae_trn @@ -41379,6 +42674,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -41933,7 +43229,7 @@ components: `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, - `de_stn`, or `unknown` + `de_stn`, `ch_uid`, or `unknown` enum: - ad_nrt - ae_trn @@ -41951,6 +43247,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -42689,6 +43986,9 @@ components: offline: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_offline_config + reboot_window: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_reboot_window stripe_s700: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config @@ -42707,6 +44007,7 @@ components: x-expandableFields: - bbpos_wisepos_e - offline + - reboot_window - stripe_s700 - tipping - verifone_p400 @@ -42824,7 +44125,7 @@ components: type: string device_type: description: >- - Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, + Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. enum: @@ -42834,6 +44135,7 @@ components: - mobile_phone_reader - simulated_wisepos_e - stripe_m2 + - stripe_s700 - verifone_P400 type: string id: @@ -42958,6 +44260,25 @@ components: title: TerminalConfigurationConfigurationResourceOfflineConfig type: object x-expandableFields: [] + terminal_configuration_configuration_resource_reboot_window: + description: '' + properties: + end_hour: + description: >- + Integer between 0 to 23 that represents the end hour of the reboot + time window. The value must be different than the start_hour. + type: integer + start_hour: + description: >- + Integer between 0 to 23 that represents the start hour of the reboot + time window. + type: integer + required: + - end_hour + - start_hour + title: TerminalConfigurationConfigurationResourceRebootWindow + type: object + x-expandableFields: [] terminal_configuration_configuration_resource_tipping: description: '' properties: @@ -46004,6 +47325,7 @@ components: - inbound_flows - outbound_flows type: string + x-stripeBypassValidation: true required: - code title: TreasuryFinancialAccountsResourceTogglesSettingStatusDetails @@ -47301,6 +48623,30 @@ paths: - enabled title: base_config_param type: object + tax_registrations: + properties: + enabled: + type: boolean + features: + properties: {} + title: base_features_param + type: object + required: + - enabled + title: base_config_param + type: object + tax_settings: + properties: + enabled: + type: boolean + features: + properties: {} + title: base_features_param + type: object + required: + - enabled + title: base_config_param + type: object title: account_session_create_components_param type: object expand: @@ -55622,7 +56968,7 @@ paths: style: form - description: >- The timestamp from when to stop aggregating meter events - (exclusive). + (exclusive). Must be aligned with minute boundaries. in: query name: end_time required: true @@ -55673,7 +57019,7 @@ paths: style: form - description: >- The timestamp from when to start aggregating meter events - (inclusive). + (inclusive). Must be aligned with minute boundaries. in: query name: start_time required: true @@ -55697,12 +57043,16 @@ paths: - description: >- Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the - specified time range. + specified time range. For hourly granularity, start and end times + must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). + For daily granularity, start and end times must align with UTC day + boundaries (00:00 UTC). in: query name: value_grouping_window required: false schema: enum: + - day - hour type: string style: form @@ -60595,6 +61945,67 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + post: + description:

Updates a Session object.

+ operationId: PostCheckoutSessionsSession + parameters: + - in: path + name: session + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/checkout.session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/checkout/sessions/{session}/expire': post: description: >- @@ -62326,6 +63737,14 @@ paths: credit note PDF. format: unix-time type: integer + email_type: + description: >- + Type of email to send to the customer, one of `credit_note` + or `none` and the default is `credit_note`. + enum: + - credit_note + - none + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -62497,239 +63916,16 @@ paths: format: unix-time type: integer style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: ID of the invoice. - in: query - name: invoice - required: true - schema: - maxLength: 5000 - type: string - style: form - - description: Line items that make up the credit note. - explode: true - in: query - name: lines - required: false - schema: - items: - properties: - amount: - type: integer - description: - maxLength: 5000 - type: string - invoice_line_item: - maxLength: 5000 - type: string - quantity: - type: integer - tax_amounts: - anyOf: - - items: - properties: - amount: - type: integer - tax_rate: - maxLength: 5000 - type: string - taxable_amount: - type: integer - required: - - amount - - tax_rate - - taxable_amount - title: tax_amount_with_tax_rate_param - type: object - type: array - - enum: - - '' - type: string - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - type: - enum: - - custom_line_item - - invoice_line_item - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - type - title: credit_note_line_item_params - type: object - type: array - style: deepObject - - description: The credit note's memo appears on the credit note PDF. - in: query - name: memo - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that - you can attach to an object. This can be useful for storing - additional information about the object in a structured format. - Individual keys can be unset by posting an empty value to them. All - keys can be unset by posting an empty value to `metadata`. - explode: true - in: query - name: metadata - required: false - schema: - additionalProperties: - type: string - type: object - style: deepObject - - description: >- - The integer amount in cents (or local equivalent) representing the - amount that is credited outside of Stripe. - in: query - name: out_of_band_amount - required: false - schema: - type: integer - style: form - description: >- - Reason for issuing this credit note, one of `duplicate`, - `fraudulent`, `order_change`, or `product_unsatisfactory` + Type of email to send to the customer, one of `credit_note` or + `none` and the default is `credit_note`. in: query - name: reason + name: email_type required: false schema: enum: - - duplicate - - fraudulent - - order_change - - product_unsatisfactory - type: string - style: form - - description: ID of an existing refund to link this credit note to. - in: query - name: refund - required: false - schema: - type: string - style: form - - description: >- - The integer amount in cents (or local equivalent) representing the - amount to refund. If set, a refund will be created for the charge - associated with the invoice. - in: query - name: refund_amount - required: false - schema: - type: integer - style: form - - description: >- - When shipping_cost contains the shipping_rate from the invoice, the - shipping_cost is included in the credit note. - explode: true - in: query - name: shipping_cost - required: false - schema: - properties: - shipping_rate: - maxLength: 5000 - type: string - title: credit_note_shipping_cost - type: object - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/credit_note' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - /v1/credit_notes/preview/lines: - get: - description: >- -

When retrieving a credit note preview, you’ll get a - lines property containing the first handful of those - items. This URL you can retrieve the full (paginated) list of line - items.

- operationId: GetCreditNotesPreviewLines - parameters: - - description: >- - The integer amount in cents (or local equivalent) representing the - total amount of the credit note. - in: query - name: amount - required: false - schema: - type: integer - style: form - - description: >- - The integer amount in cents (or local equivalent) representing the - amount to credit the customer's balance, which will be automatically - applied to their next invoice. - in: query - name: credit_amount - required: false - schema: - type: integer - style: form - - description: >- - The date when this credit note is in effect. Same as `created` - unless overwritten. When defined, this value replaces the - system-generated 'Date of issue' printed on the credit note PDF. - in: query - name: effective_at - required: false - schema: - format: unix-time - type: integer - style: form - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 + - credit_note + - none type: string style: form - description: Specifies which fields in the response should be expanded. @@ -62751,15 +63947,262 @@ paths: maxLength: 5000 type: string style: form - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form + - description: Line items that make up the credit note. + explode: true + in: query + name: lines + required: false + schema: + items: + properties: + amount: + type: integer + description: + maxLength: 5000 + type: string + invoice_line_item: + maxLength: 5000 + type: string + quantity: + type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate: + maxLength: 5000 + type: string + taxable_amount: + type: integer + required: + - amount + - tax_rate + - taxable_amount + title: tax_amount_with_tax_rate_param + type: object + type: array + - enum: + - '' + type: string + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + type: + enum: + - custom_line_item + - invoice_line_item + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - type + title: credit_note_line_item_params + type: object + type: array + style: deepObject + - description: The credit note's memo appears on the credit note PDF. + in: query + name: memo + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + you can attach to an object. This can be useful for storing + additional information about the object in a structured format. + Individual keys can be unset by posting an empty value to them. All + keys can be unset by posting an empty value to `metadata`. + explode: true + in: query + name: metadata + required: false + schema: + additionalProperties: + type: string + type: object + style: deepObject + - description: >- + The integer amount in cents (or local equivalent) representing the + amount that is credited outside of Stripe. + in: query + name: out_of_band_amount + required: false + schema: + type: integer + style: form + - description: >- + Reason for issuing this credit note, one of `duplicate`, + `fraudulent`, `order_change`, or `product_unsatisfactory` + in: query + name: reason + required: false + schema: + enum: + - duplicate + - fraudulent + - order_change + - product_unsatisfactory + type: string + style: form + - description: ID of an existing refund to link this credit note to. + in: query + name: refund + required: false + schema: + type: string + style: form + - description: >- + The integer amount in cents (or local equivalent) representing the + amount to refund. If set, a refund will be created for the charge + associated with the invoice. + in: query + name: refund_amount + required: false + schema: + type: integer + style: form + - description: >- + When shipping_cost contains the shipping_rate from the invoice, the + shipping_cost is included in the credit note. + explode: true + in: query + name: shipping_cost + required: false + schema: + properties: + shipping_rate: + maxLength: 5000 + type: string + title: credit_note_shipping_cost + type: object + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/credit_note' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/credit_notes/preview/lines: + get: + description: >- +

When retrieving a credit note preview, you’ll get a + lines property containing the first handful of those + items. This URL you can retrieve the full (paginated) list of line + items.

+ operationId: GetCreditNotesPreviewLines + parameters: + - description: >- + The integer amount in cents (or local equivalent) representing the + total amount of the credit note. + in: query + name: amount + required: false + schema: + type: integer + style: form + - description: >- + The integer amount in cents (or local equivalent) representing the + amount to credit the customer's balance, which will be automatically + applied to their next invoice. + in: query + name: credit_amount + required: false + schema: + type: integer + style: form + - description: >- + The date when this credit note is in effect. Same as `created` + unless overwritten. When defined, this value replaces the + system-generated 'Date of issue' printed on the credit note PDF. + in: query + name: effective_at + required: false + schema: + format: unix-time + type: integer + style: form + - description: >- + Type of email to send to the customer, one of `credit_note` or + `none` and the default is `credit_note`. + in: query + name: email_type + required: false + schema: + enum: + - credit_note + - none + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: ID of the invoice. + in: query + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form - description: Line items that make up the credit note. explode: true in: query @@ -63237,7 +64680,7 @@ paths: /v1/customer_sessions: post: description: >- -

Creates a customer session object that includes a single-use client +

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

operationId: PostCustomerSessions @@ -63267,6 +64710,51 @@ paths: - enabled title: buy_button_param type: object + payment_element: + properties: + enabled: + type: boolean + features: + properties: + payment_method_allow_redisplay_filters: + items: + enum: + - always + - limited + - unspecified + type: string + type: array + payment_method_redisplay: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_redisplay_limit: + type: integer + payment_method_remove: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_save: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_save_usage: + enum: + - off_session + - on_session + type: string + title: features_param + type: object + required: + - enabled + title: payment_element_param + type: object pricing_table: properties: enabled: @@ -63280,7 +64768,7 @@ paths: customer: description: >- The ID of an existing customer for which to create the - customer session. + Customer Session. maxLength: 5000 type: string expand: @@ -63758,6 +65246,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -67649,8 +69138,9 @@ paths: type: integer cancel_at_period_end: description: >- - Boolean indicating whether this subscription should cancel - at the end of the current period. + Indicate whether this subscription should cancel at the end + of the current period (`current_period_end`). Defaults to + `false`. type: boolean collection_method: description: >- @@ -67895,7 +69385,8 @@ paths: off_session: description: >- Indicates if a customer is on or off-session while an - invoice payment is attempted. + invoice payment is attempted. Defaults to `false` + (on-session). type: boolean payment_behavior: description: >- @@ -68089,6 +69580,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_linked_account_options_filters_param + type: object permissions: items: enum: @@ -68147,6 +69650,7 @@ paths: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -68670,8 +70174,9 @@ paths: will always cause a proration for that period. cancel_at_period_end: description: >- - Boolean indicating whether this subscription should cancel - at the end of the current period. + Indicate whether this subscription should cancel at the end + of the current period (`current_period_end`). Defaults to + `false`. type: boolean cancellation_details: description: Details about why this subscription was cancelled @@ -68949,7 +70454,8 @@ paths: off_session: description: >- Indicates if a customer is on or off-session while an - invoice payment is attempted. + invoice payment is attempted. Defaults to `false` + (on-session). type: boolean pause_collection: anyOf: @@ -69157,6 +70663,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_linked_account_options_filters_param + type: object permissions: items: enum: @@ -69215,6 +70733,7 @@ paths: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -69610,17 +71129,17 @@ paths: Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, - `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, - `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, - `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, - `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, - `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, - `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, - `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, - `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, - `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, - `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or - `za_vat` + `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, + `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, + `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, + `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, + `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, + `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, + `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, + `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, + `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, + `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, + or `za_vat` enum: - ad_nrt - ae_trn @@ -69638,6 +71157,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -69825,7 +71345,10 @@ paths: maxLength: 5000 type: string style: form - - explode: true + - description: >- + Only return disputes that were created during the given date + interval. + explode: true in: query name: created required: false @@ -70937,8 +72460,9 @@ paths: '/v1/events/{id}': get: description: >- -

Retrieves the details of an event. Supply the unique identifier of - the event, which you might have received in a webhook.

+

Retrieves the details of an event if it was created in the last 30 + days. Supply the unique identifier of the event, which you might have + received in a webhook.

operationId: GetEventsId parameters: - description: Specifies which fields in the response should be expanded. @@ -72353,6 +73877,16 @@ paths: filters: description: Filters to restrict the kinds of accounts to collect. properties: + account_subcategories: + items: + enum: + - checking + - credit_card + - line_of_credit + - mortgage + - savings + type: string + type: array countries: items: maxLength: 5000 @@ -75027,6 +76561,7 @@ paths: enum: - fixed_count type: string + x-stripeBypassValidation: true required: - count - interval @@ -75095,6 +76630,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_linked_account_options_filters_param + type: object permissions: items: enum: @@ -75153,6 +76700,7 @@ paths: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -75611,6 +77159,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -76730,6 +78279,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -77428,10 +78978,10 @@ paths: type: string style: deepObject - description: >- - Boolean indicating whether this subscription should cancel at the - end of the current period. This field has been deprecated and will - be removed in a future API version. Use - `subscription_details.cancel_at_period_end` instead. + Indicate whether this subscription should cancel at the end of the + current period (`current_period_end`). Defaults to `false`. This + field has been deprecated and will be removed in a future API + version. Use `subscription_details.cancel_at_period_end` instead. in: query name: subscription_cancel_at_period_end required: false @@ -78037,6 +79587,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -78770,10 +80321,10 @@ paths: type: string style: deepObject - description: >- - Boolean indicating whether this subscription should cancel at the - end of the current period. This field has been deprecated and will - be removed in a future API version. Use - `subscription_details.cancel_at_period_end` instead. + Indicate whether this subscription should cancel at the end of the + current period (`current_period_end`). Defaults to `false`. This + field has been deprecated and will be removed in a future API + version. Use `subscription_details.cancel_at_period_end` instead. in: query name: subscription_cancel_at_period_end required: false @@ -79712,6 +81263,7 @@ paths: enum: - fixed_count type: string + x-stripeBypassValidation: true required: - count - interval @@ -79780,6 +81332,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_linked_account_options_filters_param + type: object permissions: items: enum: @@ -79838,6 +81402,7 @@ paths: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -80072,6 +81637,252 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/invoices/{invoice}/add_lines': + post: + description: >- +

Adds multiple line items to an invoice. This is only possible when an + invoice is still a draft.

+ operationId: PostInvoicesInvoiceAddLines + parameters: + - in: path + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + invoice_metadata: + explode: true + style: deepObject + lines: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + invoice_metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + lines: + description: The line items to add. + items: + properties: + amount: + type: integer + description: + maxLength: 5000 + type: string + discountable: + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + invoice_item: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + period: + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + product_data: + properties: + description: + maxLength: 40000 + type: string + images: + items: + type: string + type: array + metadata: + additionalProperties: + type: string + type: object + name: + maxLength: 5000 + type: string + tax_code: + maxLength: 5000 + type: string + required: + - name + title: product_data + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + title: one_time_price_data_with_product_data + type: object + quantity: + type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate_data: + properties: + country: + maxLength: 5000 + type: string + description: + maxLength: 5000 + type: string + display_name: + maxLength: 50 + type: string + inclusive: + type: boolean + jurisdiction: + maxLength: 200 + type: string + percentage: + type: number + state: + maxLength: 2 + type: string + tax_type: + enum: + - amusement_tax + - communications_tax + - gst + - hst + - igst + - jct + - lease_tax + - pst + - qst + - rst + - sales_tax + - vat + type: string + x-stripeBypassValidation: true + required: + - display_name + - inclusive + - percentage + title: tax_rate_data_param + type: object + taxable_amount: + type: integer + required: + - amount + - tax_rate_data + - taxable_amount + title: tax_amount_param + type: object + type: array + - enum: + - '' + type: string + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: lines_data_param + type: object + type: array + required: + - lines + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/invoices/{invoice}/finalize': post: description: >- @@ -80365,11 +82176,13 @@ paths: additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty - value to `metadata`. For `type=recurring` line items, the - incoming metadata specified on the request is directly used - to set this value, in contrast to `type=invoiceitem` line - items, where any existing metadata on the invoice line is - merged with the incoming data. + value to `metadata`. For + [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) + line items, the incoming metadata specified on the request + is directly used to set this value, in contrast to + [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) + line items, where any existing metadata on the invoice line + is merged with the incoming data. period: description: >- The period associated with this invoice item. When set to @@ -80472,7 +82285,7 @@ paths: inclusive: type: boolean jurisdiction: - maxLength: 50 + maxLength: 200 type: string percentage: type: number @@ -80705,21 +82518,12 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/invoices/{invoice}/send': + '/v1/invoices/{invoice}/remove_lines': post: description: >- -

Stripe will automatically send invoices to customers according to - your subscriptions - settings. However, if you’d like to manually send an invoice to your - customer out of the normal schedule, you can do so. When sending - invoices that have already been paid, there will be no reference to the - payment in the email.

- - -

Requests made in test-mode result in no emails being sent, despite - sending an invoice.sent event.

- operationId: PostInvoicesInvoiceSend +

Removes multiple line items from an invoice. This is only possible + when an invoice is still a draft.

+ operationId: PostInvoicesInvoiceRemoveLines parameters: - in: path name: invoice @@ -80735,6 +82539,12 @@ paths: expand: explode: true style: deepObject + invoice_metadata: + explode: true + style: deepObject + lines: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -80744,8 +82554,44 @@ paths: maxLength: 5000 type: string type: array + invoice_metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + lines: + description: The line items to remove. + items: + properties: + behavior: + enum: + - delete + - unassign + type: string + id: + maxLength: 5000 + type: string + required: + - behavior + - id + title: lines_data_param + type: object + type: array + required: + - lines type: object - required: false + required: true responses: '200': content: @@ -80759,22 +82605,330 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/invoices/{invoice}/void': + '/v1/invoices/{invoice}/send': post: description: >- -

Mark a finalized invoice as void. This cannot be undone. Voiding an - invoice is similar to deletion, however it - only applies to finalized invoices and maintains a papertrail where the - invoice can still be found.

+

Stripe will automatically send invoices to customers according to + your subscriptions + settings. However, if you’d like to manually send an invoice to your + customer out of the normal schedule, you can do so. When sending + invoices that have already been paid, there will be no reference to the + payment in the email.

-

Consult with local regulations to determine whether and how an - invoice might be amended, canceled, or voided in the jurisdiction you’re - doing business in. You might need to issue - another invoice or credit note - instead. Stripe recommends that you consult with your legal counsel for - advice specific to your business.

- operationId: PostInvoicesInvoiceVoid +

Requests made in test-mode result in no emails being sent, despite + sending an invoice.sent event.

+ operationId: PostInvoicesInvoiceSend + parameters: + - in: path + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/invoices/{invoice}/update_lines': + post: + description: >- +

Updates multiple line items on an invoice. This is only possible when + an invoice is still a draft.

+ operationId: PostInvoicesInvoiceUpdateLines + parameters: + - in: path + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + invoice_metadata: + explode: true + style: deepObject + lines: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + invoice_metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. For + [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) + line items, the incoming metadata specified on the request + is directly used to set this value, in contrast to + [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) + line items, where any existing metadata on the invoice line + is merged with the incoming data. + lines: + description: The line items to update. + items: + properties: + amount: + type: integer + description: + maxLength: 5000 + type: string + discountable: + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + period: + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + product_data: + properties: + description: + maxLength: 40000 + type: string + images: + items: + type: string + type: array + metadata: + additionalProperties: + type: string + type: object + name: + maxLength: 5000 + type: string + tax_code: + maxLength: 5000 + type: string + required: + - name + title: product_data + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + title: one_time_price_data_with_product_data + type: object + quantity: + type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate_data: + properties: + country: + maxLength: 5000 + type: string + description: + maxLength: 5000 + type: string + display_name: + maxLength: 50 + type: string + inclusive: + type: boolean + jurisdiction: + maxLength: 200 + type: string + percentage: + type: number + state: + maxLength: 2 + type: string + tax_type: + enum: + - amusement_tax + - communications_tax + - gst + - hst + - igst + - jct + - lease_tax + - pst + - qst + - rst + - sales_tax + - vat + type: string + x-stripeBypassValidation: true + required: + - display_name + - inclusive + - percentage + title: tax_rate_data_param + type: object + taxable_amount: + type: integer + required: + - amount + - tax_rate_data + - taxable_amount + title: tax_amount_param + type: object + type: array + - enum: + - '' + type: string + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + required: + - id + title: lines_data_param + type: object + type: array + required: + - lines + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/invoices/{invoice}/void': + post: + description: >- +

Mark a finalized invoice as void. This cannot be undone. Voiding an + invoice is similar to deletion, however it + only applies to finalized invoices and maintains a papertrail where the + invoice can still be found.

+ + +

Consult with local regulations to determine whether and how an + invoice might be amended, canceled, or voided in the jurisdiction you’re + doing business in. You might need to issue + another invoice or credit note + instead. Stripe recommends that you consult with your legal counsel for + advice specific to your business.

+ operationId: PostInvoicesInvoiceVoid parameters: - in: path name: invoice @@ -84135,6 +86289,18 @@ paths: - postal_code title: required_address type: object + address_validation: + properties: + mode: + enum: + - disabled + - normalization_only + - validation_and_normalization + type: string + required: + - mode + title: address_validation_param + type: object customs: properties: eori_number: @@ -85245,6 +87411,9 @@ paths: pin: explode: true style: deepObject + shipping: + explode: true + style: deepObject spending_controls: explode: true style: deepObject @@ -85291,6 +87460,79 @@ paths: type: string title: encrypted_pin_param type: object + shipping: + description: Updated shipping information for the card. + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + required: + - city + - country + - line1 + - postal_code + title: required_address + type: object + address_validation: + properties: + mode: + enum: + - disabled + - normalization_only + - validation_and_normalization + type: string + required: + - mode + title: address_validation_param + type: object + customs: + properties: + eori_number: + maxLength: 5000 + type: string + title: customs_param + type: object + name: + maxLength: 5000 + type: string + phone_number: + type: string + require_signature: + type: boolean + service: + enum: + - express + - priority + - standard + type: string + x-stripeBypassValidation: true + type: + enum: + - bulk + - individual + type: string + required: + - address + - name + title: shipping_specs + type: object spending_controls: description: >- Rules that control spending for this card. Refer to our @@ -86505,7 +88747,7 @@ paths: type: string cancellation_reason: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86519,14 +88761,14 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string product_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86584,7 +88826,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86608,7 +88850,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86629,7 +88871,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86643,7 +88885,7 @@ paths: type: string return_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86677,7 +88919,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86705,14 +88947,14 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string product_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86739,14 +88981,14 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string product_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86792,14 +89034,14 @@ paths: type: string cancellation_reason: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86977,7 +89219,7 @@ paths: type: string cancellation_reason: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -86991,14 +89233,14 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string product_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87056,7 +89298,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87080,7 +89322,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87101,7 +89343,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87115,7 +89357,7 @@ paths: type: string return_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87149,7 +89391,7 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87177,14 +89419,14 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string product_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87211,14 +89453,14 @@ paths: type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string product_description: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -87264,14 +89506,14 @@ paths: type: string cancellation_reason: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' type: string explanation: anyOf: - - maxLength: 1500 + - maxLength: 2500 type: string - enum: - '' @@ -88723,6 +90965,16 @@ paths: filters: description: Filters to restrict the kinds of accounts to collect. properties: + account_subcategories: + items: + enum: + - checking + - credit_card + - line_of_credit + - mortgage + - savings + type: string + type: array countries: items: maxLength: 5000 @@ -89583,11 +91835,16 @@ paths: with this PaymentIntent. - If present in combination with - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), - this PaymentIntent's payment method will be attached to the + If + [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + is set and this PaymentIntent's payment method is not + `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any - required actions from the user are complete. + required actions from the user are complete. If the payment + method is `card_present` and isn't a digital wallet, then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Customer instead. maxLength: 5000 type: string description: @@ -90420,6 +92677,7 @@ paths: enum: - fixed_count type: string + x-stripeBypassValidation: true required: - count - interval @@ -91156,6 +93414,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + maxLength: 5000 + type: string + type: array + title: linked_account_options_filters_param + type: object permissions: items: enum: @@ -91318,6 +93588,13 @@ paths: to a Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital + wallet, then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, @@ -91731,11 +94008,16 @@ paths: with this PaymentIntent. - If present in combination with - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), - this PaymentIntent's payment method will be attached to the + If + [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + is set and this PaymentIntent's payment method is not + `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any - required actions from the user are complete. + required actions from the user are complete. If the payment + method is `card_present` and isn't a digital wallet, then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Customer instead. maxLength: 5000 type: string description: @@ -91771,7 +94053,8 @@ paths: ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) - object) to attach to this PaymentIntent. + object) to attach to this PaymentIntent. To unset this field + to null, pass in an empty string. maxLength: 5000 type: string payment_method_configuration: @@ -92481,6 +94764,7 @@ paths: enum: - fixed_count type: string + x-stripeBypassValidation: true required: - count - interval @@ -93217,6 +95501,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + maxLength: 5000 + type: string + type: array + title: linked_account_options_filters_param + type: object permissions: items: enum: @@ -93364,6 +95660,13 @@ paths: to a Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital + wallet, then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, @@ -93372,7 +95675,7 @@ paths: If `setup_future_usage` is already set and you are - performing a request using a publishable key, you may only + performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. enum: - '' @@ -94689,6 +96992,7 @@ paths: enum: - fixed_count type: string + x-stripeBypassValidation: true required: - count - interval @@ -95425,6 +97729,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + maxLength: 5000 + type: string + type: array + title: linked_account_options_filters_param + type: object permissions: items: enum: @@ -95594,6 +97910,13 @@ paths: to a Customer after the transaction completes. + If the payment method is `card_present` and isn't a digital + wallet, then a + [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Customer instead. + + When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, @@ -95602,7 +97925,7 @@ paths: If `setup_future_usage` is already set and you are - performing a request using a publishable key, you may only + performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. enum: - '' @@ -96555,6 +98878,7 @@ paths: - konbini - link - mobilepay + - multibanco - oxxo - p24 - paynow @@ -96564,8 +98888,10 @@ paths: - sepa_debit - sofort - swish + - twint - us_bank_account - wechat_pay + - zip type: string x-stripeBypassValidation: true type: array @@ -97520,6 +99846,7 @@ paths: - konbini - link - mobilepay + - multibanco - oxxo - p24 - paynow @@ -97529,8 +99856,10 @@ paths: - sepa_debit - sofort - swish + - twint - us_bank_account - wechat_pay + - zip type: string x-stripeBypassValidation: true type: array @@ -98248,6 +100577,9 @@ paths: swish: explode: true style: deepObject + twint: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject @@ -99060,6 +101392,25 @@ paths: type: object title: payment_method_param type: object + twint: + description: >- + Twint is a payment method popular in Switzerland. It allows + customers to pay using their mobile phone. Check this + [page](https://docs.stripe.com/payments/twint) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object us_bank_account: description: >- Stripe users in the United States can accept ACH direct @@ -99312,6 +101663,9 @@ paths: swish: explode: true style: deepObject + twint: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject @@ -100121,6 +102475,25 @@ paths: type: object title: payment_method_param type: object + twint: + description: >- + Twint is a payment method popular in Switzerland. It allows + customers to pay using their mobile phone. Check this + [page](https://docs.stripe.com/payments/twint) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object us_bank_account: description: >- Stripe users in the United States can accept ACH direct @@ -107609,7 +109982,7 @@ paths: get: description: >-

Returns a list of all refunds you created. We return the refunds in - sorted order, with the most recent refunds appearing first The 10 most + sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

operationId: GetRefunds parameters: @@ -110460,6 +112833,18 @@ paths: properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + maxLength: 5000 + type: string + type: array + title: linked_account_options_filters_param + type: object permissions: items: enum: @@ -110754,7 +113139,8 @@ paths: payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or saved - Source object) to attach to this SetupIntent. + Source object) to attach to this SetupIntent. To unset this + field to null, pass in an empty string. maxLength: 5000 type: string payment_method_configuration: @@ -111443,6 +113829,18 @@ paths: properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + maxLength: 5000 + type: string + type: array + title: linked_account_options_filters_param + type: object permissions: items: enum: @@ -112421,6 +114819,18 @@ paths: properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + maxLength: 5000 + type: string + type: array + title: linked_account_options_filters_param + type: object permissions: items: enum: @@ -114677,7 +117087,8 @@ paths: off_session: description: >- Indicates if a customer is on or off-session while an - invoice payment is attempted. + invoice payment is attempted. Defaults to `false` + (on-session). type: boolean payment_behavior: description: >- @@ -116991,8 +119402,9 @@ paths: type: integer cancel_at_period_end: description: >- - Boolean indicating whether this subscription should cancel - at the end of the current period. + Indicate whether this subscription should cancel at the end + of the current period (`current_period_end`). Defaults to + `false`. type: boolean collection_method: description: >- @@ -117249,7 +119661,8 @@ paths: off_session: description: >- Indicates if a customer is on or off-session while an - invoice payment is attempted. + invoice payment is attempted. Defaults to `false` + (on-session). type: boolean on_behalf_of: anyOf: @@ -117452,6 +119865,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_linked_account_options_filters_param + type: object permissions: items: enum: @@ -117510,6 +119935,7 @@ paths: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -117934,7 +120360,8 @@ paths: charge next month to make up for any price changes. To preview how the proration is calculated, use the upcoming invoice endpoint.

+ href="/docs/api/invoices/create_preview">create preview + endpoint.

By default, we prorate subscription changes. For example, if a @@ -117957,7 +120384,7 @@ paths:

  • The billing interval is changed (for example, from monthly to yearly).
    • -
  • The subscription moves from free to paid, or paid to free.
    • +
  • The subscription moves from free to paid.
  • A trial starts or ends.
    • @@ -117966,7 +120393,9 @@ paths:

    In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset - the billing date.

    + the billing date. Learn about how Stripe + immediately attempts payment for subscription changes.

    If you want to charge for an upgrade immediately, pass @@ -118219,8 +120648,9 @@ paths: will always cause a proration for that period. cancel_at_period_end: description: >- - Boolean indicating whether this subscription should cancel - at the end of the current period. + Indicate whether this subscription should cancel at the end + of the current period (`current_period_end`). Defaults to + `false`. type: boolean cancellation_details: description: Details about why this subscription was cancelled @@ -118510,7 +120940,8 @@ paths: off_session: description: >- Indicates if a customer is on or off-session while an - invoice payment is attempted. + invoice payment is attempted. Defaults to `false` + (on-session). type: boolean on_behalf_of: anyOf: @@ -118727,6 +121158,18 @@ paths: - properties: financial_connections: properties: + filters: + properties: + account_subcategories: + items: + enum: + - checking + - savings + type: string + type: array + title: >- + invoice_linked_account_options_filters_param + type: object permissions: items: enum: @@ -118785,6 +121228,7 @@ paths: - ideal - konbini - link + - multibanco - p24 - paynow - paypal @@ -119069,7 +121513,7 @@ paths: /v1/tax/calculations: post: description: >- -

    Calculates tax based on input and returns a Tax +

    Calculates tax based on the input and returns a Tax Calculation object.

    operationId: PostTaxCalculations requestBody: @@ -119183,6 +121627,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -120960,6 +123405,16 @@ paths: value to them. All keys can be unset by posting an empty value to `metadata`. type: object + posted_at: + description: >- + The Unix timestamp representing when the tax liability is + assumed or reduced, which determines the liability posting + period and handling in tax liability reports. The timestamp + must fall within the `tax_date` and the current time, unless + the `tax_date` is scheduled in advance. Defaults to the + current time. + format: unix-time + type: integer reference: description: >- A custom order or sale identifier, such as 'myOrder_123'. @@ -121605,17 +124060,17 @@ paths: Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, - `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, - `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, - `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, - `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, - `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, - `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, - `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, - `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, - `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, - `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or - `za_vat` + `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, + `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, + `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, + `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, + `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, + `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, + `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, + `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, + `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, + `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, + or `za_vat` enum: - ad_nrt - ae_trn @@ -121633,6 +124088,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - ch_uid - ch_vat - cl_tin - cn_tin @@ -122346,6 +124802,9 @@ paths: offline: explode: true style: deepObject + reboot_window: + explode: true + style: deepObject stripe_s700: explode: true style: deepObject @@ -122394,6 +124853,20 @@ paths: - '' type: string description: Configurations for collecting transactions offline. + reboot_window: + description: >- + Reboot time settings for readers that support customized + reboot time configuration. + properties: + end_hour: + type: integer + start_hour: + type: integer + required: + - end_hour + - start_hour + title: reboot_window + type: object stripe_s700: description: >- An object containing device type specific settings for @@ -122744,6 +125217,9 @@ paths: offline: explode: true style: deepObject + reboot_window: + explode: true + style: deepObject stripe_s700: explode: true style: deepObject @@ -122796,6 +125272,24 @@ paths: - '' type: string description: Configurations for collecting transactions offline. + reboot_window: + anyOf: + - properties: + end_hour: + type: integer + start_hour: + type: integer + required: + - end_hour + - start_hour + title: reboot_window + type: object + - enum: + - '' + type: string + description: >- + Reboot time settings for readers that support customized + reboot time configuration. stripe_s700: anyOf: - properties: @@ -123516,6 +126010,7 @@ paths: - mobile_phone_reader - simulated_wisepos_e - stripe_m2 + - stripe_s700 - verifone_P400 type: string x-stripeBypassValidation: true @@ -124881,6 +127376,12 @@ paths: expand: explode: true style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject merchant_data: explode: true style: deepObject @@ -124939,6 +127440,110 @@ paths: maxLength: 5000 type: string type: array + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_testmode_authorization_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + maxLength: 5000 + type: string + quantity_decimal: + format: decimal + type: string + type: + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + format: decimal + type: string + title: fuel_specs + type: object is_amount_controllable: description: >- If set `true`, you may provide @@ -125432,6 +128037,70 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: properties: departure_at: @@ -125472,6 +128141,9 @@ paths: type: object fuel: properties: + industry_product_code: + maxLength: 5000 + type: string quantity_decimal: format: decimal type: string @@ -125589,6 +128261,170 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount': + post: + description: >- +

    Finalize the amount on an Authorization prior to capture, when the + initial authorization was for an estimated amount.

    + operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount + parameters: + - in: path + name: authorization + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + final_amount: + description: >- + The final authorization amount that will be captured by the + merchant. This amount is in the authorization currency and + in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + maxLength: 5000 + type: string + quantity_decimal: + format: decimal + type: string + type: + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + format: decimal + type: string + title: fuel_specs + type: object + required: + - final_amount + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.authorization' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/increment': post: description:

    Increment a test-mode Authorization.

    @@ -126437,6 +129273,70 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: properties: departure_at: @@ -126477,6 +129377,9 @@ paths: type: object fuel: properties: + industry_product_code: + maxLength: 5000 + type: string quantity_decimal: format: decimal type: string @@ -126943,6 +129846,70 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: properties: departure_at: @@ -126983,6 +129950,9 @@ paths: type: object fuel: properties: + industry_product_code: + maxLength: 5000 + type: string quantity_decimal: format: decimal type: string @@ -133823,6 +136793,7 @@ paths: - application_fee.refund.updated - application_fee.refunded - balance.available + - billing.alert.triggered - billing_portal.configuration.created - billing_portal.configuration.updated - billing_portal.session.created @@ -133900,6 +136871,7 @@ paths: - invoice.finalization_failed - invoice.finalized - invoice.marked_uncollectible + - invoice.overdue - invoice.paid - invoice.payment_action_required - invoice.payment_failed @@ -133908,6 +136880,7 @@ paths: - invoice.upcoming - invoice.updated - invoice.voided + - invoice.will_be_due - invoiceitem.created - invoiceitem.deleted - issuing_authorization.created @@ -133920,6 +136893,7 @@ paths: - issuing_dispute.closed - issuing_dispute.created - issuing_dispute.funds_reinstated + - issuing_dispute.funds_rescinded - issuing_dispute.submitted - issuing_dispute.updated - issuing_personalization_design.activated @@ -134235,6 +137209,7 @@ paths: - application_fee.refund.updated - application_fee.refunded - balance.available + - billing.alert.triggered - billing_portal.configuration.created - billing_portal.configuration.updated - billing_portal.session.created @@ -134312,6 +137287,7 @@ paths: - invoice.finalization_failed - invoice.finalized - invoice.marked_uncollectible + - invoice.overdue - invoice.paid - invoice.payment_action_required - invoice.payment_failed @@ -134320,6 +137296,7 @@ paths: - invoice.upcoming - invoice.updated - invoice.voided + - invoice.will_be_due - invoiceitem.created - invoiceitem.deleted - issuing_authorization.created @@ -134332,6 +137309,7 @@ paths: - issuing_dispute.closed - issuing_dispute.created - issuing_dispute.funds_reinstated + - issuing_dispute.funds_rescinded - issuing_dispute.submitted - issuing_dispute.updated - issuing_personalization_design.activated diff --git a/packages/openapi-typescript/scripts/update-examples.ts b/packages/openapi-typescript/scripts/update-examples.ts index b05dd9b89..31726dcfc 100644 --- a/packages/openapi-typescript/scripts/update-examples.ts +++ b/packages/openapi-typescript/scripts/update-examples.ts @@ -22,29 +22,27 @@ async function generateSchemas() { : rootCWD; try { - await Promise.all([ - execa("./bin/cli.js", [`./examples/${name}${ext}`, "-o", `./examples/${name}.ts`], { cwd }), - ...(name === "github-api" - ? [ - execa( - "./bin/cli.js", - [ - `./examples/${name}${ext}`, - "--immutable", - "--export-type", - "-o", - `./examples/${name}-export-type-immutable.ts`, - ], - { cwd }, - ), - execa( - "./bin/cli.js", - [`./examples/${name}${ext}`, "--immutable", "-o", `./examples/${name}-immutable.ts`], - { cwd }, - ), - ] - : []), - ]); + const args: string[][] = [[`./examples/${name}${ext}`, "-o", `./examples/${name}.ts`]]; + + // addiitonal flag tests (only for GitHub API, arbitrarily-chosen so we don’t have too much noise) + if (name === "github-api") { + args.push([`./examples/${name}${ext}`, "--immutable", "-o", `./examples/${name}-immutable.ts`]); + args.push([ + `./examples/${name}${ext}`, + "--immutable", + "--export-type", + "-o", + `./examples/${name}-export-type-immutable.ts`, + ]); + args.push([ + `./examples/${name}${ext}`, + "--properties-required-by-default", + "-o", + `./examples/${name}-required.ts`, + ]); + } + + await Promise.all(args.map((a) => execa("./bin/cli.js", a, { cwd }))); schemasDoneCount++; const timeMs = Math.round(performance.now() - start); diff --git a/packages/openapi-typescript/src/transform/schema-object.ts b/packages/openapi-typescript/src/transform/schema-object.ts index ec9369e62..4ad571523 100644 --- a/packages/openapi-typescript/src/transform/schema-object.ts +++ b/packages/openapi-typescript/src/transform/schema-object.ts @@ -529,30 +529,29 @@ function transformSchemaObjectCore(schemaObject: SchemaObject, options: Transfor if (schemaObject.additionalProperties || options.ctx.additionalProperties) { const hasExplicitAdditionalProperties = typeof schemaObject.additionalProperties === "object" && Object.keys(schemaObject.additionalProperties).length; - let addlType = hasExplicitAdditionalProperties + const addlType = hasExplicitAdditionalProperties ? transformSchemaObject(schemaObject.additionalProperties as SchemaObject, options) : UNKNOWN; - // allow for `| undefined`, at least until https://github.com/microsoft/TypeScript/issues/4196 is resolved - if (addlType.kind !== ts.SyntaxKind.UnknownKeyword) { - addlType = tsUnion([addlType, UNDEFINED]); - } - coreObjectType.push( - ts.factory.createIndexSignature( - /* modifiers */ tsModifiers({ - readonly: options.ctx.immutable, - }), - /* parameters */ [ - ts.factory.createParameterDeclaration( - /* modifiers */ undefined, - /* dotDotDotToken */ undefined, - /* name */ ts.factory.createIdentifier("key"), - /* questionToken */ undefined, - /* type */ STRING, - ), - ], - /* type */ addlType, - ), - ); + return tsIntersection([ + ...(coreObjectType.length ? [ts.factory.createTypeLiteralNode(coreObjectType)] : []), + ts.factory.createTypeLiteralNode([ + ts.factory.createIndexSignature( + /* modifiers */ tsModifiers({ + readonly: options.ctx.immutable, + }), + /* parameters */ [ + ts.factory.createParameterDeclaration( + /* modifiers */ undefined, + /* dotDotDotToken */ undefined, + /* name */ ts.factory.createIdentifier("key"), + /* questionToken */ undefined, + /* type */ STRING, + ), + ], + /* type */ addlType, + ), + ]), + ]); } } diff --git a/packages/openapi-typescript/test/index.test.ts b/packages/openapi-typescript/test/index.test.ts index 45877cace..46b01c8b8 100644 --- a/packages/openapi-typescript/test/index.test.ts +++ b/packages/openapi-typescript/test/index.test.ts @@ -108,7 +108,7 @@ export type webhooks = Record; export interface components { schemas: { Base: { - [key: string]: string | undefined; + [key: string]: string; }; SchemaType: components["schemas"]["Base"] | x-swagger-bake["components"]["schemas"]["Extension"]; }; diff --git a/packages/openapi-typescript/test/transform/schema-object/object.test.ts b/packages/openapi-typescript/test/transform/schema-object/object.test.ts index c50a3c669..60290fc57 100644 --- a/packages/openapi-typescript/test/transform/schema-object/object.test.ts +++ b/packages/openapi-typescript/test/transform/schema-object/object.test.ts @@ -46,7 +46,8 @@ describe("transformSchemaObject > object", () => { }, want: `{ property?: boolean; - [key: string]: string | undefined; +} & { + [key: string]: string; }`, // options: DEFAULT_OPTIONS, }, @@ -56,15 +57,17 @@ describe("transformSchemaObject > object", () => { { given: { type: "object", additionalProperties: { type: "string" } }, want: `{ - [key: string]: string | undefined; + [key: string]: string; }`, }, ], [ "additionalProperties > true", { - given: { type: "object", additionalProperties: true }, + given: { type: "object", properties: { property: { type: "number" } }, additionalProperties: true }, want: `{ + property?: number; +} & { [key: string]: unknown; }`, }, @@ -270,6 +273,7 @@ describe("transformSchemaObject > object", () => { given: { type: "object", properties: { string: { type: "string" } } }, want: `{ string?: string; +} & { [key: string]: unknown; }`, options: {