Skip to content

Commit 4a9125f

Browse files
authored
feat: Environment(all endpoints have been updated from scheme repositories/{repository_id} to /repos/{owner}/{repo}), adds field repository.security.advisory (checkPrivateVulnerabilityReporting), docs(various resource docs have been updated and added) (#721)
BREAKING CHANGE: Updates multiple endpoints to use owner + repo in place of repository_id
1 parent f71bc31 commit 4a9125f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+779
-338
lines changed

docs/actions/createEnvironmentVariable.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Create an environment variable
3-
example: octokit.rest.actions.createEnvironmentVariable({ repository_id, environment_name, name, value })
4-
route: POST /repositories/{repository_id}/environments/{environment_name}/variables
3+
example: octokit.rest.actions.createEnvironmentVariable({ owner, repo, environment_name, name, value })
4+
route: POST /repos/{owner}/{repo}/environments/{environment_name}/variables
55
scope: actions
66
type: API method
77
---
@@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t
1616

1717
```js
1818
octokit.rest.actions.createEnvironmentVariable({
19-
repository_id,
19+
owner,
20+
repo,
2021
environment_name,
2122
name,
2223
value,
@@ -34,9 +35,14 @@ octokit.rest.actions.createEnvironmentVariable({
3435
</tr>
3536
</thead>
3637
<tbody>
37-
<tr><td>repository_id</td><td>yes</td><td>
38+
<tr><td>owner</td><td>yes</td><td>
3839

39-
The unique identifier of the repository.
40+
The account owner of the repository. The name is not case sensitive.
41+
42+
</td></tr>
43+
<tr><td>repo</td><td>yes</td><td>
44+
45+
The name of the repository without the `.git` extension. The name is not case sensitive.
4046

4147
</td></tr>
4248
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/createOrUpdateEnvironmentSecret.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Create or update an environment secret
3-
example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name, encrypted_value, key_id })
4-
route: PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
3+
example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ owner, repo, environment_name, secret_name, encrypted_value, key_id })
4+
route: PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
55
scope: actions
66
type: API method
77
---
@@ -17,7 +17,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t
1717

1818
```js
1919
octokit.rest.actions.createOrUpdateEnvironmentSecret({
20-
repository_id,
20+
owner,
21+
repo,
2122
environment_name,
2223
secret_name,
2324
encrypted_value,
@@ -36,9 +37,14 @@ octokit.rest.actions.createOrUpdateEnvironmentSecret({
3637
</tr>
3738
</thead>
3839
<tbody>
39-
<tr><td>repository_id</td><td>yes</td><td>
40+
<tr><td>owner</td><td>yes</td><td>
4041

41-
The unique identifier of the repository.
42+
The account owner of the repository. The name is not case sensitive.
43+
44+
</td></tr>
45+
<tr><td>repo</td><td>yes</td><td>
46+
47+
The name of the repository without the `.git` extension. The name is not case sensitive.
4248

4349
</td></tr>
4450
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/deleteEnvironmentSecret.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Delete an environment secret
3-
example: octokit.rest.actions.deleteEnvironmentSecret({ repository_id, environment_name, secret_name })
4-
route: DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
3+
example: octokit.rest.actions.deleteEnvironmentSecret({ owner, repo, environment_name, secret_name })
4+
route: DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
55
scope: actions
66
type: API method
77
---
@@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t
1616

1717
```js
1818
octokit.rest.actions.deleteEnvironmentSecret({
19-
repository_id,
19+
owner,
20+
repo,
2021
environment_name,
2122
secret_name,
2223
});
@@ -33,9 +34,14 @@ octokit.rest.actions.deleteEnvironmentSecret({
3334
</tr>
3435
</thead>
3536
<tbody>
36-
<tr><td>repository_id</td><td>yes</td><td>
37+
<tr><td>owner</td><td>yes</td><td>
3738

38-
The unique identifier of the repository.
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository without the `.git` extension. The name is not case sensitive.
3945

4046
</td></tr>
4147
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/deleteEnvironmentVariable.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Delete an environment variable
3-
example: octokit.rest.actions.deleteEnvironmentVariable({ repository_id, name, environment_name })
4-
route: DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}
3+
example: octokit.rest.actions.deleteEnvironmentVariable({ owner, repo, name, environment_name })
4+
route: DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
55
scope: actions
66
type: API method
77
---
@@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t
1616

1717
```js
1818
octokit.rest.actions.deleteEnvironmentVariable({
19-
repository_id,
19+
owner,
20+
repo,
2021
name,
2122
environment_name,
2223
});
@@ -33,9 +34,14 @@ octokit.rest.actions.deleteEnvironmentVariable({
3334
</tr>
3435
</thead>
3536
<tbody>
36-
<tr><td>repository_id</td><td>yes</td><td>
37+
<tr><td>owner</td><td>yes</td><td>
3738

38-
The unique identifier of the repository.
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository without the `.git` extension. The name is not case sensitive.
3945

4046
</td></tr>
4147
<tr><td>name</td><td>yes</td><td>

docs/actions/getCustomOidcSubClaimForRepo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ type: API method
99
# Get the customization template for an OIDC subject claim for a repository
1010

1111
Gets the customization template for an OpenID Connect (OIDC) subject claim.
12-
You must authenticate using an access token with the `repo` scope to use this
13-
endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint.
12+
13+
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
1414

1515
```js
1616
octokit.rest.actions.getCustomOidcSubClaimForRepo({

docs/actions/getEnvironmentPublicKey.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Get an environment public key
3-
example: octokit.rest.actions.getEnvironmentPublicKey({ repository_id, environment_name })
4-
route: GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key
3+
example: octokit.rest.actions.getEnvironmentPublicKey({ owner, repo, environment_name })
4+
route: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key
55
scope: actions
66
type: API method
77
---
@@ -17,7 +17,8 @@ If the repository is private, OAuth tokens and personal access tokens (classic)
1717

1818
```js
1919
octokit.rest.actions.getEnvironmentPublicKey({
20-
repository_id,
20+
owner,
21+
repo,
2122
environment_name,
2223
});
2324
```
@@ -33,9 +34,14 @@ octokit.rest.actions.getEnvironmentPublicKey({
3334
</tr>
3435
</thead>
3536
<tbody>
36-
<tr><td>repository_id</td><td>yes</td><td>
37+
<tr><td>owner</td><td>yes</td><td>
3738

38-
The unique identifier of the repository.
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository without the `.git` extension. The name is not case sensitive.
3945

4046
</td></tr>
4147
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/getEnvironmentSecret.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Get an environment secret
3-
example: octokit.rest.actions.getEnvironmentSecret({ repository_id, environment_name, secret_name })
4-
route: GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}
3+
example: octokit.rest.actions.getEnvironmentSecret({ owner, repo, environment_name, secret_name })
4+
route: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
55
scope: actions
66
type: API method
77
---
@@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t
1616

1717
```js
1818
octokit.rest.actions.getEnvironmentSecret({
19-
repository_id,
19+
owner,
20+
repo,
2021
environment_name,
2122
secret_name,
2223
});
@@ -33,9 +34,14 @@ octokit.rest.actions.getEnvironmentSecret({
3334
</tr>
3435
</thead>
3536
<tbody>
36-
<tr><td>repository_id</td><td>yes</td><td>
37+
<tr><td>owner</td><td>yes</td><td>
3738

38-
The unique identifier of the repository.
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository without the `.git` extension. The name is not case sensitive.
3945

4046
</td></tr>
4147
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/getEnvironmentVariable.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Get an environment variable
3-
example: octokit.rest.actions.getEnvironmentVariable({ repository_id, environment_name, name })
4-
route: GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}
3+
example: octokit.rest.actions.getEnvironmentVariable({ owner, repo, environment_name, name })
4+
route: GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
55
scope: actions
66
type: API method
77
---
@@ -16,7 +16,8 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use t
1616

1717
```js
1818
octokit.rest.actions.getEnvironmentVariable({
19-
repository_id,
19+
owner,
20+
repo,
2021
environment_name,
2122
name,
2223
});
@@ -33,9 +34,14 @@ octokit.rest.actions.getEnvironmentVariable({
3334
</tr>
3435
</thead>
3536
<tbody>
36-
<tr><td>repository_id</td><td>yes</td><td>
37+
<tr><td>owner</td><td>yes</td><td>
3738

38-
The unique identifier of the repository.
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository without the `.git` extension. The name is not case sensitive.
3945

4046
</td></tr>
4147
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/listEnvironmentSecrets.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: List environment secrets
3-
example: octokit.rest.actions.listEnvironmentSecrets({ repository_id, environment_name })
4-
route: GET /repositories/{repository_id}/environments/{environment_name}/secrets
3+
example: octokit.rest.actions.listEnvironmentSecrets({ owner, repo, environment_name })
4+
route: GET /repos/{owner}/{repo}/environments/{environment_name}/secrets
55
scope: actions
66
type: API method
77
---
@@ -17,7 +17,8 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to u
1717

1818
```js
1919
octokit.rest.actions.listEnvironmentSecrets({
20-
repository_id,
20+
owner,
21+
repo,
2122
environment_name,
2223
});
2324
```
@@ -33,9 +34,14 @@ octokit.rest.actions.listEnvironmentSecrets({
3334
</tr>
3435
</thead>
3536
<tbody>
36-
<tr><td>repository_id</td><td>yes</td><td>
37+
<tr><td>owner</td><td>yes</td><td>
3738

38-
The unique identifier of the repository.
39+
The account owner of the repository. The name is not case sensitive.
40+
41+
</td></tr>
42+
<tr><td>repo</td><td>yes</td><td>
43+
44+
The name of the repository without the `.git` extension. The name is not case sensitive.
3945

4046
</td></tr>
4147
<tr><td>environment_name</td><td>yes</td><td>

docs/actions/listEnvironmentVariables.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: List environment variables
3-
example: octokit.rest.actions.listEnvironmentVariables({ repository_id, environment_name })
4-
route: GET /repositories/{repository_id}/environments/{environment_name}/variables
3+
example: octokit.rest.actions.listEnvironmentVariables({ owner, repo, environment_name })
4+
route: GET /repos/{owner}/{repo}/environments/{environment_name}/variables
55
scope: actions
66
type: API method
77
---
@@ -16,7 +16,8 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to u
1616

1717
```js
1818
octokit.rest.actions.listEnvironmentVariables({
19-
repository_id,
19+
owner,
20+
repo,
2021
environment_name,
2122
});
2223
```
@@ -32,9 +33,14 @@ octokit.rest.actions.listEnvironmentVariables({
3233
</tr>
3334
</thead>
3435
<tbody>
35-
<tr><td>repository_id</td><td>yes</td><td>
36+
<tr><td>owner</td><td>yes</td><td>
3637

37-
The unique identifier of the repository.
38+
The account owner of the repository. The name is not case sensitive.
39+
40+
</td></tr>
41+
<tr><td>repo</td><td>yes</td><td>
42+
43+
The name of the repository without the `.git` extension. The name is not case sensitive.
3844

3945
</td></tr>
4046
<tr><td>environment_name</td><td>yes</td><td>

0 commit comments

Comments
 (0)