Skip to content

Commit ad024fe

Browse files
octokitbotoctokitbot
authored
feat: Updates openapi-types to v21.0.0 (which had breaking changes), BREAKING CHANGE: Updates multiple endpoints to use owner + repo in place of repository_id (#625)
BREAKING CHANGE: Updates multiple endpoints to use owner + repo in place of repository_id
1 parent 2425655 commit ad024fe

File tree

4 files changed

+125
-147
lines changed

4 files changed

+125
-147
lines changed

‎package-lock.json

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+2-2
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": "^20.0.0"
9+
"@octokit/openapi-types": "^21.0.0"
1010
},
1111
"scripts": {
1212
"build": "node scripts/build.mjs && tsc -p tsconfig.json",
@@ -80,6 +80,6 @@
8080
]
8181
},
8282
"octokit": {
83-
"openapi-version": "14.0.0"
83+
"openapi-version": "14.1.0"
8484
}
8585
}

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

+42-71
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,11 @@
8383
},
8484
{
8585
"method": "POST",
86-
"url": "/repositories/{repository_id}/environments/{environment_name}/variables",
86+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/variables",
8787
"documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-environment-variable",
8888
"parameters": [
89-
{
90-
"alias": null,
91-
"deprecated": null,
92-
"in": "PATH",
93-
"name": "repository_id"
94-
},
89+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
90+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
9591
{
9692
"alias": null,
9793
"deprecated": null,
@@ -105,15 +101,11 @@
105101
},
106102
{
107103
"method": "PUT",
108-
"url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
104+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}",
109105
"documentationUrl": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret",
110106
"parameters": [
111-
{
112-
"alias": null,
113-
"deprecated": null,
114-
"in": "PATH",
115-
"name": "repository_id"
116-
},
107+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
108+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
117109
{
118110
"alias": null,
119111
"deprecated": null,
@@ -311,15 +303,11 @@
311303
},
312304
{
313305
"method": "DELETE",
314-
"url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
306+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}",
315307
"documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret",
316308
"parameters": [
317-
{
318-
"alias": null,
319-
"deprecated": null,
320-
"in": "PATH",
321-
"name": "repository_id"
322-
},
309+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
310+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
323311
{
324312
"alias": null,
325313
"deprecated": null,
@@ -332,15 +320,11 @@
332320
},
333321
{
334322
"method": "DELETE",
335-
"url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}",
323+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}",
336324
"documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable",
337325
"parameters": [
338-
{
339-
"alias": null,
340-
"deprecated": null,
341-
"in": "PATH",
342-
"name": "repository_id"
343-
},
326+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
327+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
344328
{ "alias": null, "deprecated": null, "in": "PATH", "name": "name" },
345329
{
346330
"alias": null,
@@ -685,15 +669,11 @@
685669
},
686670
{
687671
"method": "GET",
688-
"url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key",
672+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key",
689673
"documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key",
690674
"parameters": [
691-
{
692-
"alias": null,
693-
"deprecated": null,
694-
"in": "PATH",
695-
"name": "repository_id"
696-
},
675+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
676+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
697677
{
698678
"alias": null,
699679
"deprecated": null,
@@ -705,15 +685,11 @@
705685
},
706686
{
707687
"method": "GET",
708-
"url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
688+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}",
709689
"documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret",
710690
"parameters": [
711-
{
712-
"alias": null,
713-
"deprecated": null,
714-
"in": "PATH",
715-
"name": "repository_id"
716-
},
691+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
692+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
717693
{
718694
"alias": null,
719695
"deprecated": null,
@@ -726,15 +702,11 @@
726702
},
727703
{
728704
"method": "GET",
729-
"url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}",
705+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}",
730706
"documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-environment-variable",
731707
"parameters": [
732-
{
733-
"alias": null,
734-
"deprecated": null,
735-
"in": "PATH",
736-
"name": "repository_id"
737-
},
708+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
709+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
738710
{
739711
"alias": null,
740712
"deprecated": null,
@@ -1006,15 +978,11 @@
1006978
},
1007979
{
1008980
"method": "GET",
1009-
"url": "/repositories/{repository_id}/environments/{environment_name}/secrets",
981+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/secrets",
1010982
"documentationUrl": "https://docs.github.com/rest/actions/secrets#list-environment-secrets",
1011983
"parameters": [
1012-
{
1013-
"alias": null,
1014-
"deprecated": null,
1015-
"in": "PATH",
1016-
"name": "repository_id"
1017-
},
984+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
985+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
1018986
{
1019987
"alias": null,
1020988
"deprecated": null,
@@ -1028,15 +996,11 @@
1028996
},
1029997
{
1030998
"method": "GET",
1031-
"url": "/repositories/{repository_id}/environments/{environment_name}/variables",
999+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/variables",
10321000
"documentationUrl": "https://docs.github.com/rest/actions/variables#list-environment-variables",
10331001
"parameters": [
1034-
{
1035-
"alias": null,
1036-
"deprecated": null,
1037-
"in": "PATH",
1038-
"name": "repository_id"
1039-
},
1002+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
1003+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
10401004
{
10411005
"alias": null,
10421006
"deprecated": null,
@@ -1761,15 +1725,11 @@
17611725
},
17621726
{
17631727
"method": "PATCH",
1764-
"url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}",
1728+
"url": "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}",
17651729
"documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-environment-variable",
17661730
"parameters": [
1767-
{
1768-
"alias": null,
1769-
"deprecated": null,
1770-
"in": "PATH",
1771-
"name": "repository_id"
1772-
},
1731+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
1732+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
17731733
{ "alias": null, "deprecated": null, "in": "BODY", "name": "name" },
17741734
{
17751735
"alias": null,
@@ -6897,7 +6857,8 @@
68976857
"documentationUrl": "https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository",
68986858
"parameters": [
68996859
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
6900-
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }
6860+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" },
6861+
{ "alias": null, "deprecated": null, "in": "QUERY", "name": "ref" }
69016862
],
69026863
"renamed": null
69036864
},
@@ -10656,6 +10617,16 @@
1065610617
],
1065710618
"renamed": null
1065810619
},
10620+
{
10621+
"method": "GET",
10622+
"url": "/repos/{owner}/{repo}/private-vulnerability-reporting",
10623+
"documentationUrl": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository",
10624+
"parameters": [
10625+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "owner" },
10626+
{ "alias": null, "deprecated": null, "in": "PATH", "name": "repo" }
10627+
],
10628+
"renamed": null
10629+
},
1065910630
{
1066010631
"method": "GET",
1066110632
"url": "/repos/{owner}/{repo}/vulnerability-alerts",

0 commit comments

Comments
 (0)