Skip to content

Commit b162e5d

Browse files
octokitbotoctokitbot
authored
feat: add support for new public beta APIs for creating, reading, updating and deleting custom repo roles (POST /orgs/{org}/custom_roles, PATCH /orgs/{org}/custom_roles/{role_id}, DELETE /orgs/{org}/custom_roles/{role_id}, GET /orgs/{org}/fine_grained_permissions) (#455)
WIP octokit/openapi updated
1 parent 25ff4a2 commit b162e5d

File tree

4 files changed

+105
-17
lines changed

4 files changed

+105
-17
lines changed

‎package-lock.json

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
"description": "Shared TypeScript definitions for Octokit projects",
88
"dependencies": {
9-
"@octokit/openapi-types": "^13.8.0"
9+
"@octokit/openapi-types": "^13.9.0"
1010
},
1111
"scripts": {
1212
"build": "pika-pack build",
@@ -96,7 +96,7 @@
9696
]
9797
},
9898
"octokit": {
99-
"openapi-version": "7.9.0"
99+
"openapi-version": "7.10.0"
100100
},
101101
"renovate": {
102102
"extends": [

‎scripts/update-endpoints/generated/endpoints.json

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7815,6 +7815,25 @@
78157815
"previews": [],
78167816
"renamed": null
78177817
},
7818+
{
7819+
"method": "POST",
7820+
"url": "/orgs/{org}/custom_roles",
7821+
"documentationUrl": "https://docs.github.com/rest/reference/orgs#create-a-custom-role",
7822+
"parameters": [
7823+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
7824+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
7825+
{
7826+
"alias": null,
7827+
"deprecated": null,
7828+
"in": "BODY",
7829+
"name": "description"
7830+
},
7831+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "base_role" },
7832+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "permissions" }
7833+
],
7834+
"previews": [],
7835+
"renamed": null
7836+
},
78187837
{
78197838
"method": "POST",
78207839
"url": "/orgs/{org}/invitations",
@@ -7874,6 +7893,17 @@
78747893
"previews": [],
78757894
"renamed": null
78767895
},
7896+
{
7897+
"method": "DELETE",
7898+
"url": "/orgs/{org}/custom_roles/{role_id}",
7899+
"documentationUrl": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role",
7900+
"parameters": [
7901+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
7902+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "role_id" }
7903+
],
7904+
"previews": [],
7905+
"renamed": null
7906+
},
78777907
{
78787908
"method": "DELETE",
78797909
"url": "/orgs/{org}/hooks/{hook_id}",
@@ -8043,6 +8073,16 @@
80438073
"previews": [],
80448074
"renamed": null
80458075
},
8076+
{
8077+
"method": "GET",
8078+
"url": "/orgs/{org}/fine_grained_permissions",
8079+
"documentationUrl": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization",
8080+
"parameters": [
8081+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" }
8082+
],
8083+
"previews": [],
8084+
"renamed": null
8085+
},
80468086
{
80478087
"method": "GET",
80488088
"url": "/user/orgs",
@@ -8470,6 +8510,26 @@
84708510
"previews": [],
84718511
"renamed": null
84728512
},
8513+
{
8514+
"method": "PATCH",
8515+
"url": "/orgs/{org}/custom_roles/{role_id}",
8516+
"documentationUrl": "https://docs.github.com/rest/reference/orgs#update-a-custom-role",
8517+
"parameters": [
8518+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "org" },
8519+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "role_id" },
8520+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
8521+
{
8522+
"alias": null,
8523+
"deprecated": null,
8524+
"in": "BODY",
8525+
"name": "description"
8526+
},
8527+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "base_role" },
8528+
{ "alias": null, "deprecated": null, "in": "BODY", "name": "permissions" }
8529+
],
8530+
"previews": [],
8531+
"renamed": null
8532+
},
84738533
{
84748534
"method": "PATCH",
84758535
"url": "/user/memberships/orgs/{org}",
@@ -8691,7 +8751,7 @@
86918751
{
86928752
"method": "GET",
86938753
"url": "/orgs/{org}/packages/{package_type}/{package_name}/versions",
8694-
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization",
8754+
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization",
86958755
"parameters": [
86968756
{
86978757
"alias": null,
@@ -8716,7 +8776,7 @@
87168776
{
87178777
"method": "GET",
87188778
"url": "/user/packages/{package_type}/{package_name}/versions",
8719-
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user",
8779+
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user",
87208780
"parameters": [
87218781
{
87228782
"alias": null,
@@ -8740,7 +8800,7 @@
87408800
{
87418801
"method": "GET",
87428802
"url": "/user/packages/{package_type}/{package_name}/versions",
8743-
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user",
8803+
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user",
87448804
"parameters": [
87458805
{
87468806
"alias": null,
@@ -8764,7 +8824,7 @@
87648824
{
87658825
"method": "GET",
87668826
"url": "/orgs/{org}/packages/{package_type}/{package_name}/versions",
8767-
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization",
8827+
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization",
87688828
"parameters": [
87698829
{
87708830
"alias": null,
@@ -8789,7 +8849,7 @@
87898849
{
87908850
"method": "GET",
87918851
"url": "/users/{username}/packages/{package_type}/{package_name}/versions",
8792-
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user",
8852+
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user",
87938853
"parameters": [
87948854
{
87958855
"alias": null,

‎src/generated/Endpoints.ts

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,13 @@ export interface Endpoints {
285285
"/orgs/{org}/credential-authorizations/{credential_id}",
286286
"delete"
287287
>;
288+
/**
289+
* @see https://docs.github.com/rest/reference/orgs#delete-a-custom-role
290+
*/
291+
"DELETE /orgs/{org}/custom_roles/{role_id}": Operation<
292+
"/orgs/{org}/custom_roles/{role_id}",
293+
"delete"
294+
>;
288295
/**
289296
* @see https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret
290297
*/
@@ -1701,6 +1708,13 @@ export interface Endpoints {
17011708
"/orgs/{org}/failed_invitations",
17021709
"get"
17031710
>;
1711+
/**
1712+
* @see https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization
1713+
*/
1714+
"GET /orgs/{org}/fine_grained_permissions": Operation<
1715+
"/orgs/{org}/fine_grained_permissions",
1716+
"get"
1717+
>;
17041718
/**
17051719
* @see https://docs.github.com/rest/reference/orgs#list-organization-webhooks
17061720
*/
@@ -1828,7 +1842,7 @@ export interface Endpoints {
18281842
"get"
18291843
>;
18301844
/**
1831-
* @see https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization
1845+
* @see https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization
18321846
*/
18331847
"GET /orgs/{org}/packages/{package_type}/{package_name}/versions": Operation<
18341848
"/orgs/{org}/packages/{package_type}/{package_name}/versions",
@@ -3821,7 +3835,7 @@ export interface Endpoints {
38213835
"get"
38223836
>;
38233837
/**
3824-
* @see https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user
3838+
* @see https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user
38253839
*/
38263840
"GET /user/packages/{package_type}/{package_name}/versions": Operation<
38273841
"/user/packages/{package_type}/{package_name}/versions",
@@ -3974,7 +3988,7 @@ export interface Endpoints {
39743988
"get"
39753989
>;
39763990
/**
3977-
* @see https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user
3991+
* @see https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user
39783992
*/
39793993
"GET /users/{username}/packages/{package_type}/{package_name}/versions": Operation<
39803994
"/users/{username}/packages/{package_type}/{package_name}/versions",
@@ -4105,6 +4119,13 @@ export interface Endpoints {
41054119
"/orgs/{org}/actions/runner-groups/{runner_group_id}",
41064120
"patch"
41074121
>;
4122+
/**
4123+
* @see https://docs.github.com/rest/reference/orgs#update-a-custom-role
4124+
*/
4125+
"PATCH /orgs/{org}/custom_roles/{role_id}": Operation<
4126+
"/orgs/{org}/custom_roles/{role_id}",
4127+
"patch"
4128+
>;
41084129
/**
41094130
* @see https://docs.github.com/rest/reference/orgs#update-an-organization-webhook
41104131
*/
@@ -4519,6 +4540,13 @@ export interface Endpoints {
45194540
"/orgs/{org}/actions/runners/{runner_id}/labels",
45204541
"post"
45214542
>;
4543+
/**
4544+
* @see https://docs.github.com/rest/reference/orgs#create-a-custom-role
4545+
*/
4546+
"POST /orgs/{org}/custom_roles": Operation<
4547+
"/orgs/{org}/custom_roles",
4548+
"post"
4549+
>;
45224550
/**
45234551
* @see https://docs.github.com/rest/reference/orgs#create-an-organization-webhook
45244552
*/

0 commit comments

Comments
 (0)