| page | no |
diff --git a/docs/users/addEmailForAuthenticated.md b/docs/users/addEmailForAuthenticated.md
index c920fb40a..65e859685 100644
--- a/docs/users/addEmailForAuthenticated.md
+++ b/docs/users/addEmailForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Add an email address for the authenticated user
+**Deprecated:** This method has been renamed to users.addEmailForAuthenticatedUser
+
This endpoint is accessible with the `user` scope.
```js
diff --git a/docs/users/addEmailForAuthenticatedUser.md b/docs/users/addEmailForAuthenticatedUser.md
new file mode 100644
index 000000000..3c8271146
--- /dev/null
+++ b/docs/users/addEmailForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Add an email address for the authenticated user
+example: octokit.rest.users.addEmailForAuthenticatedUser({ emails })
+route: POST /user/emails
+scope: users
+type: API method
+---
+
+# Add an email address for the authenticated user
+
+This endpoint is accessible with the `user` scope.
+
+```js
+octokit.rest.users.addEmailForAuthenticatedUser({
+ emails,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | emails | yes |
+
+Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user).
diff --git a/docs/users/createGpgKeyForAuthenticated.md b/docs/users/createGpgKeyForAuthenticated.md
index 7b0e70f14..9499214bd 100644
--- a/docs/users/createGpgKeyForAuthenticated.md
+++ b/docs/users/createGpgKeyForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Create a GPG key for the authenticated user
+**Deprecated:** This method has been renamed to users.createGpgKeyForAuthenticatedUser
+
Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/createGpgKeyForAuthenticatedUser.md b/docs/users/createGpgKeyForAuthenticatedUser.md
new file mode 100644
index 000000000..083cd7f8c
--- /dev/null
+++ b/docs/users/createGpgKeyForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Create a GPG key for the authenticated user
+example: octokit.rest.users.createGpgKeyForAuthenticatedUser({ armored_public_key })
+route: POST /user/gpg_keys
+scope: users
+type: API method
+---
+
+# Create a GPG key for the authenticated user
+
+Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.createGpgKeyForAuthenticatedUser({
+ armored_public_key,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | armored_public_key | yes |
+
+A GPG key in ASCII-armored format.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user).
diff --git a/docs/users/createPublicSshKeyForAuthenticated.md b/docs/users/createPublicSshKeyForAuthenticated.md
index 06d20ff44..a6444bff1 100644
--- a/docs/users/createPublicSshKeyForAuthenticated.md
+++ b/docs/users/createPublicSshKeyForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Create a public SSH key for the authenticated user
+**Deprecated:** This method has been renamed to users.createPublicSshKeyForAuthenticatedUser
+
Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/createPublicSshKeyForAuthenticatedUser.md b/docs/users/createPublicSshKeyForAuthenticatedUser.md
new file mode 100644
index 000000000..3007e0347
--- /dev/null
+++ b/docs/users/createPublicSshKeyForAuthenticatedUser.md
@@ -0,0 +1,43 @@
+---
+name: Create a public SSH key for the authenticated user
+example: octokit.rest.users.createPublicSshKeyForAuthenticatedUser({ key })
+route: POST /user/keys
+scope: users
+type: API method
+---
+
+# Create a public SSH key for the authenticated user
+
+Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.createPublicSshKeyForAuthenticatedUser({
+ key,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | title | no |
+
+A descriptive name for the new key.
+
+ |
+| key | yes |
+
+The public SSH key to add to your GitHub account.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user).
diff --git a/docs/users/deleteEmailForAuthenticated.md b/docs/users/deleteEmailForAuthenticated.md
index 077b0d134..e563402bf 100644
--- a/docs/users/deleteEmailForAuthenticated.md
+++ b/docs/users/deleteEmailForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Delete an email address for the authenticated user
+**Deprecated:** This method has been renamed to users.deleteEmailForAuthenticatedUser
+
This endpoint is accessible with the `user` scope.
```js
diff --git a/docs/users/deleteEmailForAuthenticatedUser.md b/docs/users/deleteEmailForAuthenticatedUser.md
new file mode 100644
index 000000000..67578d46e
--- /dev/null
+++ b/docs/users/deleteEmailForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Delete an email address for the authenticated user
+example: octokit.rest.users.deleteEmailForAuthenticatedUser({ emails })
+route: DELETE /user/emails
+scope: users
+type: API method
+---
+
+# Delete an email address for the authenticated user
+
+This endpoint is accessible with the `user` scope.
+
+```js
+octokit.rest.users.deleteEmailForAuthenticatedUser({
+ emails,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | emails | yes |
+
+Email addresses associated with the GitHub user account.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user).
diff --git a/docs/users/deleteGpgKeyForAuthenticated.md b/docs/users/deleteGpgKeyForAuthenticated.md
index 26f86bce1..4c15dc3a9 100644
--- a/docs/users/deleteGpgKeyForAuthenticated.md
+++ b/docs/users/deleteGpgKeyForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Delete a GPG key for the authenticated user
+**Deprecated:** This method has been renamed to users.deleteGpgKeyForAuthenticatedUser
+
Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/deleteGpgKeyForAuthenticatedUser.md b/docs/users/deleteGpgKeyForAuthenticatedUser.md
new file mode 100644
index 000000000..8ca3ed38f
--- /dev/null
+++ b/docs/users/deleteGpgKeyForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Delete a GPG key for the authenticated user
+example: octokit.rest.users.deleteGpgKeyForAuthenticatedUser({ gpg_key_id })
+route: DELETE /user/gpg_keys/{gpg_key_id}
+scope: users
+type: API method
+---
+
+# Delete a GPG key for the authenticated user
+
+Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.deleteGpgKeyForAuthenticatedUser({
+ gpg_key_id,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | gpg_key_id | yes |
+
+gpg_key_id parameter
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user).
diff --git a/docs/users/deletePublicSshKeyForAuthenticated.md b/docs/users/deletePublicSshKeyForAuthenticated.md
index 25f02050b..acd4a3e54 100644
--- a/docs/users/deletePublicSshKeyForAuthenticated.md
+++ b/docs/users/deletePublicSshKeyForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Delete a public SSH key for the authenticated user
+**Deprecated:** This method has been renamed to users.deletePublicSshKeyForAuthenticatedUser
+
Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/deletePublicSshKeyForAuthenticatedUser.md b/docs/users/deletePublicSshKeyForAuthenticatedUser.md
new file mode 100644
index 000000000..5a48cc6e6
--- /dev/null
+++ b/docs/users/deletePublicSshKeyForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Delete a public SSH key for the authenticated user
+example: octokit.rest.users.deletePublicSshKeyForAuthenticatedUser({ key_id })
+route: DELETE /user/keys/{key_id}
+scope: users
+type: API method
+---
+
+# Delete a public SSH key for the authenticated user
+
+Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.deletePublicSshKeyForAuthenticatedUser({
+ key_id,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | key_id | yes |
+
+key_id parameter
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user).
diff --git a/docs/users/getGpgKeyForAuthenticated.md b/docs/users/getGpgKeyForAuthenticated.md
index ed7ba5341..2874f6777 100644
--- a/docs/users/getGpgKeyForAuthenticated.md
+++ b/docs/users/getGpgKeyForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Get a GPG key for the authenticated user
+**Deprecated:** This method has been renamed to users.getGpgKeyForAuthenticatedUser
+
View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/getGpgKeyForAuthenticatedUser.md b/docs/users/getGpgKeyForAuthenticatedUser.md
new file mode 100644
index 000000000..fba7c7824
--- /dev/null
+++ b/docs/users/getGpgKeyForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Get a GPG key for the authenticated user
+example: octokit.rest.users.getGpgKeyForAuthenticatedUser({ gpg_key_id })
+route: GET /user/gpg_keys/{gpg_key_id}
+scope: users
+type: API method
+---
+
+# Get a GPG key for the authenticated user
+
+View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.getGpgKeyForAuthenticatedUser({
+ gpg_key_id,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | gpg_key_id | yes |
+
+gpg_key_id parameter
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user).
diff --git a/docs/users/getPublicSshKeyForAuthenticated.md b/docs/users/getPublicSshKeyForAuthenticated.md
index e4ba35af0..1059f80bc 100644
--- a/docs/users/getPublicSshKeyForAuthenticated.md
+++ b/docs/users/getPublicSshKeyForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Get a public SSH key for the authenticated user
+**Deprecated:** This method has been renamed to users.getPublicSshKeyForAuthenticatedUser
+
View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/getPublicSshKeyForAuthenticatedUser.md b/docs/users/getPublicSshKeyForAuthenticatedUser.md
new file mode 100644
index 000000000..1d4fbc10a
--- /dev/null
+++ b/docs/users/getPublicSshKeyForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Get a public SSH key for the authenticated user
+example: octokit.rest.users.getPublicSshKeyForAuthenticatedUser({ key_id })
+route: GET /user/keys/{key_id}
+scope: users
+type: API method
+---
+
+# Get a public SSH key for the authenticated user
+
+View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.getPublicSshKeyForAuthenticatedUser({
+ key_id,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | key_id | yes |
+
+key_id parameter
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user).
diff --git a/docs/users/listBlockedByAuthenticated.md b/docs/users/listBlockedByAuthenticated.md
index 441d4a28e..a2415d7f3 100644
--- a/docs/users/listBlockedByAuthenticated.md
+++ b/docs/users/listBlockedByAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# List users blocked by the authenticated user
+**Deprecated:** This method has been renamed to users.listBlockedByAuthenticatedUser
+
List the users you've blocked on your personal account.
```js
diff --git a/docs/users/listBlockedByAuthenticatedUser.md b/docs/users/listBlockedByAuthenticatedUser.md
new file mode 100644
index 000000000..485e0e967
--- /dev/null
+++ b/docs/users/listBlockedByAuthenticatedUser.md
@@ -0,0 +1,21 @@
+---
+name: List users blocked by the authenticated user
+example: octokit.rest.users.listBlockedByAuthenticatedUser()
+route: GET /user/blocks
+scope: users
+type: API method
+---
+
+# List users blocked by the authenticated user
+
+List the users you've blocked on your personal account.
+
+```js
+octokit.rest.users.listBlockedByAuthenticatedUser();
+```
+
+## Parameters
+
+This endpoint has no parameters
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user).
diff --git a/docs/users/listEmailsForAuthenticated.md b/docs/users/listEmailsForAuthenticated.md
index 9040c5370..627984273 100644
--- a/docs/users/listEmailsForAuthenticated.md
+++ b/docs/users/listEmailsForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# List email addresses for the authenticated user
+**Deprecated:** This method has been renamed to users.listEmailsForAuthenticatedUser
+
Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
```js
diff --git a/docs/users/listEmailsForAuthenticatedUser.md b/docs/users/listEmailsForAuthenticatedUser.md
new file mode 100644
index 000000000..e8d1120e0
--- /dev/null
+++ b/docs/users/listEmailsForAuthenticatedUser.md
@@ -0,0 +1,41 @@
+---
+name: List email addresses for the authenticated user
+example: octokit.rest.users.listEmailsForAuthenticatedUser()
+route: GET /user/emails
+scope: users
+type: API method
+---
+
+# List email addresses for the authenticated user
+
+Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
+
+```js
+octokit.rest.users.listEmailsForAuthenticatedUser();
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | per_page | no |
+
+Results per page (max 100)
+
+ |
+| page | no |
+
+Page number of the results to fetch.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user).
diff --git a/docs/users/listFollowedByAuthenticated.md b/docs/users/listFollowedByAuthenticated.md
index b3c34381b..77c90e702 100644
--- a/docs/users/listFollowedByAuthenticated.md
+++ b/docs/users/listFollowedByAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# List the people the authenticated user follows
+**Deprecated:** This method has been renamed to users.listFollowedByAuthenticatedUser
+
Lists the people who the authenticated user follows.
```js
diff --git a/docs/users/listFollowedByAuthenticatedUser.md b/docs/users/listFollowedByAuthenticatedUser.md
new file mode 100644
index 000000000..af36edc8f
--- /dev/null
+++ b/docs/users/listFollowedByAuthenticatedUser.md
@@ -0,0 +1,41 @@
+---
+name: List the people the authenticated user follows
+example: octokit.rest.users.listFollowedByAuthenticatedUser()
+route: GET /user/following
+scope: users
+type: API method
+---
+
+# List the people the authenticated user follows
+
+Lists the people who the authenticated user follows.
+
+```js
+octokit.rest.users.listFollowedByAuthenticatedUser();
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | per_page | no |
+
+Results per page (max 100)
+
+ |
+| page | no |
+
+Page number of the results to fetch.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows).
diff --git a/docs/users/listGpgKeysForAuthenticated.md b/docs/users/listGpgKeysForAuthenticated.md
index fe49e344c..784a73b4a 100644
--- a/docs/users/listGpgKeysForAuthenticated.md
+++ b/docs/users/listGpgKeysForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# List GPG keys for the authenticated user
+**Deprecated:** This method has been renamed to users.listGpgKeysForAuthenticatedUser
+
Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/listGpgKeysForAuthenticatedUser.md b/docs/users/listGpgKeysForAuthenticatedUser.md
new file mode 100644
index 000000000..2db81898c
--- /dev/null
+++ b/docs/users/listGpgKeysForAuthenticatedUser.md
@@ -0,0 +1,41 @@
+---
+name: List GPG keys for the authenticated user
+example: octokit.rest.users.listGpgKeysForAuthenticatedUser()
+route: GET /user/gpg_keys
+scope: users
+type: API method
+---
+
+# List GPG keys for the authenticated user
+
+Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.listGpgKeysForAuthenticatedUser();
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | per_page | no |
+
+Results per page (max 100)
+
+ |
+| page | no |
+
+Page number of the results to fetch.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user).
diff --git a/docs/users/listPublicEmailsForAuthenticated.md b/docs/users/listPublicEmailsForAuthenticated.md
index 0f17e9db9..91dbb8b1b 100644
--- a/docs/users/listPublicEmailsForAuthenticated.md
+++ b/docs/users/listPublicEmailsForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# List public email addresses for the authenticated user
+**Deprecated:** This method has been renamed to users.listPublicEmailsForAuthenticatedUser
+
Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
```js
diff --git a/docs/users/listPublicEmailsForAuthenticatedUser.md b/docs/users/listPublicEmailsForAuthenticatedUser.md
new file mode 100644
index 000000000..1da066154
--- /dev/null
+++ b/docs/users/listPublicEmailsForAuthenticatedUser.md
@@ -0,0 +1,41 @@
+---
+name: List public email addresses for the authenticated user
+example: octokit.rest.users.listPublicEmailsForAuthenticatedUser()
+route: GET /user/public_emails
+scope: users
+type: API method
+---
+
+# List public email addresses for the authenticated user
+
+Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
+
+```js
+octokit.rest.users.listPublicEmailsForAuthenticatedUser();
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | per_page | no |
+
+Results per page (max 100)
+
+ |
+| page | no |
+
+Page number of the results to fetch.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user).
diff --git a/docs/users/listPublicSshKeysForAuthenticated.md b/docs/users/listPublicSshKeysForAuthenticated.md
index aea0ed7a0..d76a38cd9 100644
--- a/docs/users/listPublicSshKeysForAuthenticated.md
+++ b/docs/users/listPublicSshKeysForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# List public SSH keys for the authenticated user
+**Deprecated:** This method has been renamed to users.listPublicSshKeysForAuthenticatedUser
+
Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
```js
diff --git a/docs/users/listPublicSshKeysForAuthenticatedUser.md b/docs/users/listPublicSshKeysForAuthenticatedUser.md
new file mode 100644
index 000000000..2d386849f
--- /dev/null
+++ b/docs/users/listPublicSshKeysForAuthenticatedUser.md
@@ -0,0 +1,41 @@
+---
+name: List public SSH keys for the authenticated user
+example: octokit.rest.users.listPublicSshKeysForAuthenticatedUser()
+route: GET /user/keys
+scope: users
+type: API method
+---
+
+# List public SSH keys for the authenticated user
+
+Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+
+```js
+octokit.rest.users.listPublicSshKeysForAuthenticatedUser();
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | per_page | no |
+
+Results per page (max 100)
+
+ |
+| page | no |
+
+Page number of the results to fetch.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user).
diff --git a/docs/users/setPrimaryEmailVisibilityForAuthenticated.md b/docs/users/setPrimaryEmailVisibilityForAuthenticated.md
index 5b6ba567b..3c8a4907d 100644
--- a/docs/users/setPrimaryEmailVisibilityForAuthenticated.md
+++ b/docs/users/setPrimaryEmailVisibilityForAuthenticated.md
@@ -8,6 +8,8 @@ type: API method
# Set primary email visibility for the authenticated user
+**Deprecated:** This method has been renamed to users.setPrimaryEmailVisibilityForAuthenticatedUser
+
Sets the visibility for your primary email addresses.
```js
diff --git a/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md b/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md
new file mode 100644
index 000000000..d18d894e3
--- /dev/null
+++ b/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md
@@ -0,0 +1,38 @@
+---
+name: Set primary email visibility for the authenticated user
+example: octokit.rest.users.setPrimaryEmailVisibilityForAuthenticatedUser({ visibility })
+route: PATCH /user/email/visibility
+scope: users
+type: API method
+---
+
+# Set primary email visibility for the authenticated user
+
+Sets the visibility for your primary email addresses.
+
+```js
+octokit.rest.users.setPrimaryEmailVisibilityForAuthenticatedUser({
+ visibility,
+});
+```
+
+## Parameters
+
+
+
+
+ | name |
+ required |
+ description |
+
+
+
+ | visibility | yes |
+
+Denotes whether an email is publicly visible.
+
+ |
+
+
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user).
diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
index 55d90b3ab..b2e0ed347 100644
--- a/scripts/update-endpoints/generated/endpoints.json
+++ b/scripts/update-endpoints/generated/endpoints.json
@@ -1426,6 +1426,76 @@
"responses": [{ "code": 302, "description": "Response", "examples": null }],
"renamed": null
},
+ {
+ "name": "Download workflow run attempt logs",
+ "scope": "actions",
+ "id": "downloadWorkflowRunAttemptLogs",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "attempt_num",
+ "description": "The attempt number of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "attempt_number",
+ "description": "The attempt number of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 302, "description": "Response", "examples": null }],
+ "renamed": null
+ },
{
"name": "Download workflow run logs",
"scope": "actions",
@@ -2022,7 +2092,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}"
+ "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}"
}
]
}
@@ -2697,16 +2767,16 @@
"renamed": null
},
{
- "name": "Get workflow run usage",
+ "name": "Get a workflow run attempt",
"scope": "actions",
- "id": "getWorkflowRunUsage",
+ "id": "getWorkflowRunAttempt",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage",
+ "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt",
"previews": [],
"headers": [],
"parameters": [
@@ -2748,6 +2818,19 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "attempt_number",
+ "description": "The attempt number of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -2756,7 +2839,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}"
+ "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}"
}
]
}
@@ -2764,16 +2847,16 @@
"renamed": null
},
{
- "name": "Get workflow usage",
+ "name": "Get workflow run usage",
"scope": "actions",
- "id": "getWorkflowUsage",
+ "id": "getWorkflowRunUsage",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage",
+ "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage",
"previews": [],
"headers": [],
"parameters": [
@@ -2804,10 +2887,10 @@
"deprecated": null
},
{
- "name": "workflow_id",
- "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "name": "run_id",
+ "description": "The id of the workflow run.",
"in": "PATH",
- "type": null,
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -2823,7 +2906,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}"
+ "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}"
}
]
}
@@ -2831,16 +2914,16 @@
"renamed": null
},
{
- "name": "List artifacts for a repository",
+ "name": "Get workflow usage",
"scope": "actions",
- "id": "listArtifactsForRepo",
+ "id": "getWorkflowUsage",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/artifacts",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository",
+ "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage",
"previews": [],
"headers": [],
"parameters": [
@@ -2871,24 +2954,11 @@
"deprecated": null
},
{
- "name": "per_page",
- "description": "Results per page (max 100)",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
+ "name": "workflow_id",
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "in": "PATH",
+ "type": null,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -2903,7 +2973,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}"
+ "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}"
}
]
}
@@ -2911,24 +2981,24 @@
"renamed": null
},
{
- "name": "List environment secrets",
+ "name": "List artifacts for a repository",
"scope": "actions",
- "id": "listEnvironmentSecrets",
+ "id": "listArtifactsForRepo",
"method": "GET",
- "url": "/repositories/{repository_id}/environments/{environment_name}/secrets",
+ "url": "/repos/{owner}/{repo}/actions/artifacts",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets",
+ "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "repository_id",
+ "name": "owner",
"description": "",
"in": "PATH",
- "type": "integer",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -2938,8 +3008,8 @@
"deprecated": null
},
{
- "name": "environment_name",
- "description": "The name of the environment",
+ "name": "repo",
+ "description": "",
"in": "PATH",
"type": "string",
"required": true,
@@ -2983,7 +3053,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
+ "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}"
}
]
}
@@ -2991,49 +3061,23 @@
"renamed": null
},
{
- "name": "List jobs for a workflow run",
+ "name": "List environment secrets",
"scope": "actions",
- "id": "listJobsForWorkflowRun",
+ "id": "listEnvironmentSecrets",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
+ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run",
+ "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
+ "name": "repository_id",
"description": "",
"in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The id of the workflow run.",
- "in": "PATH",
"type": "integer",
"required": true,
"enum": null,
@@ -3044,75 +3088,181 @@
"deprecated": null
},
{
- "name": "filter",
- "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["latest", "all"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "Results per page (max 100)",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List organization secrets",
- "scope": "actions",
- "id": "listOrgSecrets",
- "method": "GET",
- "url": "/orgs/{org}/actions/secrets",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "",
+ "name": "environment_name",
+ "description": "The name of the environment",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "List jobs for a workflow run",
+ "scope": "actions",
+ "id": "listJobsForWorkflowRun",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "run_id",
+ "description": "The id of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "filter",
+ "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": ["latest", "all"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "List organization secrets",
+ "scope": "actions",
+ "id": "listOrgSecrets",
+ "method": "GET",
+ "url": "/orgs/{org}/actions/secrets",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "",
"in": "PATH",
"type": "string",
"required": true,
@@ -4145,7 +4295,7 @@
"isDeprecated": true,
"deprecationDate": "2021-09-14",
"removalDate": null,
- "description": "**Deprecation Notice:** This endpoint is deprecated.\nWe recommend migrating your existing code to use the new [retry workflow](https://docs.github.com/rest/reference/actions#retry-a-workflow) endpoint.\n\nRe-runs your workflow run using its `id`. You must authenticate using\nan access token with the `repo` scope to use this endpoint. GitHub Apps must have\nthe `actions:write` permission to use this endpoint.",
+ "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-a-workflow",
"previews": [],
"headers": [],
@@ -4261,63 +4411,6 @@
],
"renamed": null
},
- {
- "name": "Retry a workflow",
- "scope": "actions",
- "id": "retryWorkflow",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/retry",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Retry your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#retry-a-workflow",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The id of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 201, "description": "Response", "examples": null }],
- "renamed": null
- },
{
"name": "Review pending deployments for a workflow run",
"scope": "actions",
@@ -6856,6 +6949,63 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "apps", "id": "addRepoToInstallation" },
+ "after": {
+ "scope": "apps",
+ "id": "addRepoToInstallationForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Add a repository to an app installation",
+ "scope": "apps",
+ "id": "addRepoToInstallationForAuthenticatedUser",
+ "method": "PUT",
+ "url": "/user/installations/{installation_id}/repositories/{repository_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repository_id",
+ "description": "",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -9037,6 +9187,63 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "apps", "id": "removeRepoFromInstallation" },
+ "after": {
+ "scope": "apps",
+ "id": "removeRepoFromInstallationForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Remove a repository from an app installation",
+ "scope": "apps",
+ "id": "removeRepoFromInstallationForAuthenticatedUser",
+ "method": "DELETE",
+ "url": "/user/installations/{installation_id}/repositories/{repository_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repository_id",
+ "description": "",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -10814,6 +11021,76 @@
],
"renamed": null
},
+ {
+ "name": "Rerequest a check run",
+ "scope": "checks",
+ "id": "rerequestRun",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "documentationUrl": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 201, "description": "Response", "examples": null },
+ {
+ "code": 403,
+ "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
+ "examples": null
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation error if the check run is not rerequestable",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
{
"name": "Rerequest a check suite",
"scope": "checks",
@@ -11579,7 +11856,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"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},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\"instances\":null}"
+ "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"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},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}"
}
]
},
@@ -11602,7 +11879,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `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.",
+ "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).",
"documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository",
"previews": [],
"headers": [],
@@ -21039,6 +21316,74 @@
],
"renamed": null
},
+ {
+ "name": "List repositories for a user migration",
+ "scope": "migrations",
+ "id": "listReposForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/migrations/{migration_id}/repositories",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists all the repositories for this user migration.",
+ "documentationUrl": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "migration_id",
+ "description": "migration_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"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}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"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-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
+ "renamed": null
+ },
{
"name": "List repositories in an organization migration",
"scope": "migrations",
@@ -21186,7 +21531,12 @@
},
{ "code": 404, "description": "Resource not found", "examples": null }
],
- "renamed": null
+ "renamed": {
+ "before": { "scope": "migrations", "id": "listReposForUser" },
+ "after": { "scope": "migrations", "id": "listReposForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
},
{
"name": "Map a commit author",
@@ -34677,53 +35027,35 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 409, "description": "Conflict", "examples": null }
],
- "renamed": null
+ "renamed": {
+ "before": { "scope": "repos", "id": "acceptInvitation" },
+ "after": {
+ "scope": "repos",
+ "id": "acceptInvitationForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
},
{
- "name": "Add app access restrictions",
+ "name": "Accept a repository invitation",
"scope": "repos",
- "id": "addAppAccessRestrictions",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
+ "id": "acceptInvitationForAuthenticatedUser",
+ "method": "PATCH",
+ "url": "/user/repository_invitations/{invitation_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions",
+ "description": "",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "branch",
- "description": "The name of the branch.",
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -34731,46 +35063,109 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "apps",
- "description": "",
- "in": "BODY",
- "type": null,
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": true,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"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\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"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\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]"
- }
- ]
- },
- { "code": 422, "description": "Validation failed", "examples": null }
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 409, "description": "Conflict", "examples": null }
],
"renamed": null
},
{
- "name": "Add a repository collaborator",
+ "name": "Add app access restrictions",
"scope": "repos",
- "id": "addCollaborator",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/collaborators/{username}",
+ "id": "addAppAccessRestrictions",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote 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 verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
- "documentationUrl": "https://docs.github.com/rest/reference/repos#add-a-repository-collaborator",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "branch",
+ "description": "The name of the branch.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "apps",
+ "description": "",
+ "in": "BODY",
+ "type": null,
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": true,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"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\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"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\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]"
+ }
+ ]
+ },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Add a repository collaborator",
+ "scope": "repos",
+ "id": "addCollaborator",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/collaborators/{username}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote 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 verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#add-a-repository-collaborator",
"previews": [],
"headers": [],
"parameters": [
@@ -35644,7 +36039,7 @@
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#create-commit-signature-protection",
- "previews": [{ "name": "zzzax" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -36779,7 +37174,7 @@
},
{
"name": "visibility",
- "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
+ "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.",
"in": "BODY",
"type": "string",
"required": false,
@@ -37384,7 +37779,7 @@
"removalDate": null,
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
"documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-github-pages-site",
- "previews": [{ "name": "switcheroo" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -37464,11 +37859,6 @@
]
},
{ "code": 409, "description": "Conflict", "examples": null },
- {
- "code": 415,
- "description": "Preview header missing",
- "examples": null
- },
{ "code": 422, "description": "Validation failed", "examples": null }
],
"renamed": null
@@ -37603,6 +37993,19 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "generate_release_notes",
+ "description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -37635,7 +38038,7 @@
"removalDate": null,
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
"documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template",
- "previews": [{ "name": "baptiste" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -37965,6 +38368,51 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 409, "description": "Conflict", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "repos", "id": "declineInvitation" },
+ "after": {
+ "scope": "repos",
+ "id": "declineInvitationForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Decline a repository invitation",
+ "scope": "repos",
+ "id": "declineInvitationForAuthenticatedUser",
+ "method": "DELETE",
+ "url": "/user/repository_invitations/{invitation_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 409, "description": "Conflict", "examples": null }
+ ],
"renamed": null
},
{
@@ -38391,7 +38839,7 @@
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#delete-commit-signature-protection",
- "previews": [{ "name": "zzzax" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -38814,7 +39262,7 @@
"removalDate": null,
"description": "",
"documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-github-pages-site",
- "previews": [{ "name": "switcheroo" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -38847,11 +39295,6 @@
"responses": [
{ "code": 204, "description": "Response", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 415,
- "description": "Preview header missing",
- "examples": null
- },
{ "code": 422, "description": "Validation failed", "examples": null }
],
"renamed": null
@@ -39599,6 +40042,113 @@
"responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
+ {
+ "name": "Generate release notes content for a release",
+ "scope": "repos",
+ "id": "generateReleaseNotes",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/releases/generate-notes",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#generate-release-notes",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "tag_name",
+ "description": "The tag name for the release. This can be an existing tag or a new one.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "target_commitish",
+ "description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "previous_tag_name",
+ "description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "configuration_file_path",
+ "description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Name and body of generated release notes",
+ "examples": [
+ {
+ "data": "{\"name\":\"Release v1.0.0 is now available!\",\"body\":\"##Changes in Release v1.0.0 ... ##Contributors @monalisa\"}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
+ "renamed": null
+ },
{
"name": "Get a repository",
"scope": "repos",
@@ -40776,7 +41326,7 @@
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen 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://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#get-commit-signature-protection",
- "previews": [{ "name": "zzzax" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -46875,7 +47425,7 @@
},
{
"name": "visibility",
- "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.",
+ "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
"in": "BODY",
"type": "string",
"required": false,
@@ -48864,7 +49414,7 @@
"removalDate": null,
"description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
"documentationUrl": "https://docs.github.com/rest/reference/search#search-commits",
- "previews": [{ "name": "cloak" }],
+ "previews": [],
"headers": [],
"parameters": [
{
@@ -48943,8 +49493,7 @@
}
]
},
- { "code": 304, "description": "Not modified", "examples": null },
- { "code": 415, "description": "Preview header missing", "examples": null }
+ { "code": 304, "description": "Not modified", "examples": null }
],
"renamed": null
},
@@ -49253,7 +49802,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"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}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}"
+ "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"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}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"visibility\":\"private\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}"
}
]
},
@@ -49492,6 +50041,7 @@
}
]
},
+ { "code": 304, "description": "Not modified", "examples": null },
{
"code": 404,
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found",
@@ -49543,7 +50093,20 @@
},
{
"name": "secret_type",
- "description": "A comma separated list of secret types to return. By default all secret types are returned.",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "resolution",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -49651,7 +50214,20 @@
},
{
"name": "secret_type",
- "description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "resolution",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -54264,6 +54840,61 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 422, "description": "Validation failed", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "addEmailForAuthenticated" },
+ "after": { "scope": "users", "id": "addEmailForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Add an email address for the authenticated user",
+ "scope": "users",
+ "id": "addEmailForAuthenticatedUser",
+ "method": "POST",
+ "url": "/user/emails",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "This endpoint is accessible with the `user` scope.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "emails",
+ "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
+ "in": "BODY",
+ "type": "string[]",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"mona@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
"renamed": null
},
{
@@ -54509,6 +55140,61 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 422, "description": "Validation failed", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "createGpgKeyForAuthenticated" },
+ "after": { "scope": "users", "id": "createGpgKeyForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Create a GPG key for the authenticated user",
+ "scope": "users",
+ "id": "createGpgKeyForAuthenticatedUser",
+ "method": "POST",
+ "url": "/user/gpg_keys",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "armored_public_key",
+ "description": "A GPG key in ASCII-armored format.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
"renamed": null
},
{
@@ -54572,6 +55258,80 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 422, "description": "Validation failed", "examples": null }
],
+ "renamed": {
+ "before": {
+ "scope": "users",
+ "id": "createPublicSshKeyForAuthenticated"
+ },
+ "after": {
+ "scope": "users",
+ "id": "createPublicSshKeyForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Create a public SSH key for the authenticated user",
+ "scope": "users",
+ "id": "createPublicSshKeyForAuthenticatedUser",
+ "method": "POST",
+ "url": "/user/keys",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "title",
+ "description": "A descriptive name for the new key.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "key",
+ "description": "The public SSH key to add to your GitHub account.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ",
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
"renamed": null
},
{
@@ -54614,6 +55374,53 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 422, "description": "Validation failed", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "deleteEmailForAuthenticated" },
+ "after": { "scope": "users", "id": "deleteEmailForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Delete an email address for the authenticated user",
+ "scope": "users",
+ "id": "deleteEmailForAuthenticatedUser",
+ "method": "DELETE",
+ "url": "/user/emails",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "This endpoint is accessible with the `user` scope.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "emails",
+ "description": "Email addresses associated with the GitHub user account.",
+ "in": "BODY",
+ "type": "string[]",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
"renamed": null
},
{
@@ -54656,6 +55463,53 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 422, "description": "Validation failed", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "deleteGpgKeyForAuthenticated" },
+ "after": { "scope": "users", "id": "deleteGpgKeyForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Delete a GPG key for the authenticated user",
+ "scope": "users",
+ "id": "deleteGpgKeyForAuthenticatedUser",
+ "method": "DELETE",
+ "url": "/user/gpg_keys/{gpg_key_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
"renamed": null
},
{
@@ -54697,6 +55551,58 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": {
+ "scope": "users",
+ "id": "deletePublicSshKeyForAuthenticated"
+ },
+ "after": {
+ "scope": "users",
+ "id": "deletePublicSshKeyForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Delete a public SSH key for the authenticated user",
+ "scope": "users",
+ "id": "deletePublicSshKeyForAuthenticatedUser",
+ "method": "DELETE",
+ "url": "/user/keys/{key_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -54939,6 +55845,60 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "getGpgKeyForAuthenticated" },
+ "after": { "scope": "users", "id": "getGpgKeyForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Get a GPG key for the authenticated user",
+ "scope": "users",
+ "id": "getGpgKeyForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/gpg_keys/{gpg_key_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -54988,6 +55948,63 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "getPublicSshKeyForAuthenticated" },
+ "after": {
+ "scope": "users",
+ "id": "getPublicSshKeyForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Get a public SSH key for the authenticated user",
+ "scope": "users",
+ "id": "getPublicSshKeyForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/keys/{key_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -55079,6 +56096,47 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 415, "description": "Preview header missing", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "listBlockedByAuthenticated" },
+ "after": { "scope": "users", "id": "listBlockedByAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "List users blocked by the authenticated user",
+ "scope": "users",
+ "id": "listBlockedByAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/blocks",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "List the users you've blocked on your personal account.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"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}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 415, "description": "Preview header missing", "examples": null }
+ ],
"renamed": null
},
{
@@ -55128,7 +56186,136 @@
"description": "Response",
"examples": [
{
- "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]"
+ "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
+ "renamed": {
+ "before": { "scope": "users", "id": "listEmailsForAuthenticated" },
+ "after": { "scope": "users", "id": "listEmailsForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "List email addresses for the authenticated user",
+ "scope": "users",
+ "id": "listEmailsForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/emails",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "List the people the authenticated user follows",
+ "scope": "users",
+ "id": "listFollowedByAuthenticated",
+ "method": "GET",
+ "url": "/user/following",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists the people who the authenticated user follows.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"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}]"
}
]
},
@@ -55138,15 +56325,19 @@
"description": "Requires authentication",
"examples": null
},
- { "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null }
+ { "code": 403, "description": "Forbidden", "examples": null }
],
- "renamed": null
+ "renamed": {
+ "before": { "scope": "users", "id": "listFollowedByAuthenticated" },
+ "after": { "scope": "users", "id": "listFollowedByAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
},
{
"name": "List the people the authenticated user follows",
"scope": "users",
- "id": "listFollowedByAuthenticated",
+ "id": "listFollowedByAuthenticatedUser",
"method": "GET",
"url": "/user/following",
"isDeprecated": false,
@@ -55459,6 +56650,73 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "listGpgKeysForAuthenticated" },
+ "after": { "scope": "users", "id": "listGpgKeysForAuthenticatedUser" },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "List GPG keys for the authenticated user",
+ "scope": "users",
+ "id": "listGpgKeysForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/gpg_keys",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -55588,6 +56846,76 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "listPublicEmailsForAuthenticated" },
+ "after": {
+ "scope": "users",
+ "id": "listPublicEmailsForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "List public email addresses for the authenticated user",
+ "scope": "users",
+ "id": "listPublicEmailsForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/public_emails",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -55713,6 +57041,76 @@
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null }
],
+ "renamed": {
+ "before": { "scope": "users", "id": "listPublicSshKeysForAuthenticated" },
+ "after": {
+ "scope": "users",
+ "id": "listPublicSshKeysForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "List public SSH keys for the authenticated user",
+ "scope": "users",
+ "id": "listPublicSshKeysForAuthenticatedUser",
+ "method": "GET",
+ "url": "/user/keys",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false},{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/3\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAB\",\"created_at\":\"2020-07-11T21:31:57Z\",\"verified\":false,\"read_only\":false}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
@@ -55763,6 +57161,67 @@
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 422, "description": "Validation failed", "examples": null }
],
+ "renamed": {
+ "before": {
+ "scope": "users",
+ "id": "setPrimaryEmailVisibilityForAuthenticated"
+ },
+ "after": {
+ "scope": "users",
+ "id": "setPrimaryEmailVisibilityForAuthenticatedUser"
+ },
+ "date": "2021-10-05",
+ "note": null
+ }
+ },
+ {
+ "name": "Set primary email visibility for the authenticated user",
+ "scope": "users",
+ "id": "setPrimaryEmailVisibilityForAuthenticatedUser",
+ "method": "PATCH",
+ "url": "/user/email/visibility",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Sets the visibility for your primary email addresses.",
+ "documentationUrl": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "visibility",
+ "description": "Denotes whether an email is publicly visible.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": ["public", "private"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"email\":\"octocat@github.com\",\"primary\":true,\"verified\":true,\"visibility\":\"private\"}]"
+ }
+ ]
+ },
+ { "code": 304, "description": "Not modified", "examples": null },
+ {
+ "code": 401,
+ "description": "Requires authentication",
+ "examples": null
+ },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
"renamed": null
},
{
diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts
index 73c262d82..38ca4a2d5 100644
--- a/src/generated/endpoints.ts
+++ b/src/generated/endpoints.ts
@@ -62,6 +62,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
downloadJobLogsForWorkflowRun: [
"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
],
+ downloadWorkflowRunAttemptLogs: [
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs",
+ ],
downloadWorkflowRunLogs: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs",
],
@@ -112,6 +115,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
],
getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"],
getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"],
+ getWorkflowRunAttempt: [
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}",
+ ],
getWorkflowRunUsage: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing",
],
@@ -150,7 +156,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
removeSelectedRepoFromOrgSecret: [
"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
],
- retryWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry"],
reviewPendingDeploymentsForRun: [
"POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
],
@@ -221,6 +226,11 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
apps: {
addRepoToInstallation: [
"PUT /user/installations/{installation_id}/repositories/{repository_id}",
+ {},
+ { renamed: ["apps", "addRepoToInstallationForAuthenticatedUser"] },
+ ],
+ addRepoToInstallationForAuthenticatedUser: [
+ "PUT /user/installations/{installation_id}/repositories/{repository_id}",
],
checkToken: ["POST /applications/{client_id}/token"],
createContentAttachment: [
@@ -274,6 +284,11 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
],
removeRepoFromInstallation: [
"DELETE /user/installations/{installation_id}/repositories/{repository_id}",
+ {},
+ { renamed: ["apps", "removeRepoFromInstallationForAuthenticatedUser"] },
+ ],
+ removeRepoFromInstallationForAuthenticatedUser: [
+ "DELETE /user/installations/{installation_id}/repositories/{repository_id}",
],
resetToken: ["PATCH /applications/{client_id}/token"],
revokeInstallationAccessToken: ["DELETE /installation/token"],
@@ -313,6 +328,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
],
listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"],
+ rerequestRun: [
+ "POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
+ ],
rerequestSuite: [
"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest",
],
@@ -551,8 +569,15 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}"],
listForAuthenticatedUser: ["GET /user/migrations"],
listForOrg: ["GET /orgs/{org}/migrations"],
+ listReposForAuthenticatedUser: [
+ "GET /user/migrations/{migration_id}/repositories",
+ ],
listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories"],
- listReposForUser: ["GET /user/migrations/{migration_id}/repositories"],
+ listReposForUser: [
+ "GET /user/migrations/{migration_id}/repositories",
+ {},
+ { renamed: ["migrations", "listReposForAuthenticatedUser"] },
+ ],
mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"],
setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"],
startForAuthenticatedUser: ["POST /user/migrations"],
@@ -856,7 +881,14 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
],
},
repos: {
- acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"],
+ acceptInvitation: [
+ "PATCH /user/repository_invitations/{invitation_id}",
+ {},
+ { renamed: ["repos", "acceptInvitationForAuthenticatedUser"] },
+ ],
+ acceptInvitationForAuthenticatedUser: [
+ "PATCH /user/repository_invitations/{invitation_id}",
+ ],
addAppAccessRestrictions: [
"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
{},
@@ -892,7 +924,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
],
createCommitSignatureProtection: [
"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
- { mediaType: { previews: ["zzzax"] } },
],
createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"],
createDeployKey: ["POST /repos/{owner}/{repo}/keys"],
@@ -908,17 +939,20 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
"PUT /repos/{owner}/{repo}/environments/{environment_name}",
],
createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"],
- createPagesSite: [
- "POST /repos/{owner}/{repo}/pages",
- { mediaType: { previews: ["switcheroo"] } },
- ],
+ createPagesSite: ["POST /repos/{owner}/{repo}/pages"],
createRelease: ["POST /repos/{owner}/{repo}/releases"],
createUsingTemplate: [
"POST /repos/{template_owner}/{template_repo}/generate",
- { mediaType: { previews: ["baptiste"] } },
],
createWebhook: ["POST /repos/{owner}/{repo}/hooks"],
- declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"],
+ declineInvitation: [
+ "DELETE /user/repository_invitations/{invitation_id}",
+ {},
+ { renamed: ["repos", "declineInvitationForAuthenticatedUser"] },
+ ],
+ declineInvitationForAuthenticatedUser: [
+ "DELETE /user/repository_invitations/{invitation_id}",
+ ],
delete: ["DELETE /repos/{owner}/{repo}"],
deleteAccessRestrictions: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
@@ -936,7 +970,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"],
deleteCommitSignatureProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
- { mediaType: { previews: ["zzzax"] } },
],
deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"],
deleteDeployment: [
@@ -946,10 +979,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
deleteInvitation: [
"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}",
],
- deletePagesSite: [
- "DELETE /repos/{owner}/{repo}/pages",
- { mediaType: { previews: ["switcheroo"] } },
- ],
+ deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages"],
deletePullRequestReviewProtection: [
"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
],
@@ -979,6 +1009,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
enableVulnerabilityAlerts: [
"PUT /repos/{owner}/{repo}/vulnerability-alerts",
],
+ generateReleaseNotes: [
+ "POST /repos/{owner}/{repo}/releases/generate-notes",
+ ],
get: ["GET /repos/{owner}/{repo}"],
getAccessRestrictions: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
@@ -1013,7 +1046,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"],
getCommitSignatureProtection: [
"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
- { mediaType: { previews: ["zzzax"] } },
],
getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"],
getContent: ["GET /repos/{owner}/{repo}/contents/{path}"],
@@ -1200,7 +1232,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
},
search: {
code: ["GET /search/code"],
- commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }],
+ commits: ["GET /search/commits"],
issuesAndPullRequests: ["GET /search/issues"],
labels: ["GET /search/labels"],
repos: ["GET /search/repositories"],
@@ -1286,35 +1318,112 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"],
},
users: {
- addEmailForAuthenticated: ["POST /user/emails"],
+ addEmailForAuthenticated: [
+ "POST /user/emails",
+ {},
+ { renamed: ["users", "addEmailForAuthenticatedUser"] },
+ ],
+ addEmailForAuthenticatedUser: ["POST /user/emails"],
block: ["PUT /user/blocks/{username}"],
checkBlocked: ["GET /user/blocks/{username}"],
checkFollowingForUser: ["GET /users/{username}/following/{target_user}"],
checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"],
- createGpgKeyForAuthenticated: ["POST /user/gpg_keys"],
- createPublicSshKeyForAuthenticated: ["POST /user/keys"],
- deleteEmailForAuthenticated: ["DELETE /user/emails"],
- deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"],
- deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"],
+ createGpgKeyForAuthenticated: [
+ "POST /user/gpg_keys",
+ {},
+ { renamed: ["users", "createGpgKeyForAuthenticatedUser"] },
+ ],
+ createGpgKeyForAuthenticatedUser: ["POST /user/gpg_keys"],
+ createPublicSshKeyForAuthenticated: [
+ "POST /user/keys",
+ {},
+ { renamed: ["users", "createPublicSshKeyForAuthenticatedUser"] },
+ ],
+ createPublicSshKeyForAuthenticatedUser: ["POST /user/keys"],
+ deleteEmailForAuthenticated: [
+ "DELETE /user/emails",
+ {},
+ { renamed: ["users", "deleteEmailForAuthenticatedUser"] },
+ ],
+ deleteEmailForAuthenticatedUser: ["DELETE /user/emails"],
+ deleteGpgKeyForAuthenticated: [
+ "DELETE /user/gpg_keys/{gpg_key_id}",
+ {},
+ { renamed: ["users", "deleteGpgKeyForAuthenticatedUser"] },
+ ],
+ deleteGpgKeyForAuthenticatedUser: ["DELETE /user/gpg_keys/{gpg_key_id}"],
+ deletePublicSshKeyForAuthenticated: [
+ "DELETE /user/keys/{key_id}",
+ {},
+ { renamed: ["users", "deletePublicSshKeyForAuthenticatedUser"] },
+ ],
+ deletePublicSshKeyForAuthenticatedUser: ["DELETE /user/keys/{key_id}"],
follow: ["PUT /user/following/{username}"],
getAuthenticated: ["GET /user"],
getByUsername: ["GET /users/{username}"],
getContextForUser: ["GET /users/{username}/hovercard"],
- getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"],
- getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"],
+ getGpgKeyForAuthenticated: [
+ "GET /user/gpg_keys/{gpg_key_id}",
+ {},
+ { renamed: ["users", "getGpgKeyForAuthenticatedUser"] },
+ ],
+ getGpgKeyForAuthenticatedUser: ["GET /user/gpg_keys/{gpg_key_id}"],
+ getPublicSshKeyForAuthenticated: [
+ "GET /user/keys/{key_id}",
+ {},
+ { renamed: ["users", "getPublicSshKeyForAuthenticatedUser"] },
+ ],
+ getPublicSshKeyForAuthenticatedUser: ["GET /user/keys/{key_id}"],
list: ["GET /users"],
- listBlockedByAuthenticated: ["GET /user/blocks"],
- listEmailsForAuthenticated: ["GET /user/emails"],
- listFollowedByAuthenticated: ["GET /user/following"],
+ listBlockedByAuthenticated: [
+ "GET /user/blocks",
+ {},
+ { renamed: ["users", "listBlockedByAuthenticatedUser"] },
+ ],
+ listBlockedByAuthenticatedUser: ["GET /user/blocks"],
+ listEmailsForAuthenticated: [
+ "GET /user/emails",
+ {},
+ { renamed: ["users", "listEmailsForAuthenticatedUser"] },
+ ],
+ listEmailsForAuthenticatedUser: ["GET /user/emails"],
+ listFollowedByAuthenticated: [
+ "GET /user/following",
+ {},
+ { renamed: ["users", "listFollowedByAuthenticatedUser"] },
+ ],
+ listFollowedByAuthenticatedUser: ["GET /user/following"],
listFollowersForAuthenticatedUser: ["GET /user/followers"],
listFollowersForUser: ["GET /users/{username}/followers"],
listFollowingForUser: ["GET /users/{username}/following"],
- listGpgKeysForAuthenticated: ["GET /user/gpg_keys"],
+ listGpgKeysForAuthenticated: [
+ "GET /user/gpg_keys",
+ {},
+ { renamed: ["users", "listGpgKeysForAuthenticatedUser"] },
+ ],
+ listGpgKeysForAuthenticatedUser: ["GET /user/gpg_keys"],
listGpgKeysForUser: ["GET /users/{username}/gpg_keys"],
- listPublicEmailsForAuthenticated: ["GET /user/public_emails"],
+ listPublicEmailsForAuthenticated: [
+ "GET /user/public_emails",
+ {},
+ { renamed: ["users", "listPublicEmailsForAuthenticatedUser"] },
+ ],
+ listPublicEmailsForAuthenticatedUser: ["GET /user/public_emails"],
listPublicKeysForUser: ["GET /users/{username}/keys"],
- listPublicSshKeysForAuthenticated: ["GET /user/keys"],
- setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"],
+ listPublicSshKeysForAuthenticated: [
+ "GET /user/keys",
+ {},
+ { renamed: ["users", "listPublicSshKeysForAuthenticatedUser"] },
+ ],
+ listPublicSshKeysForAuthenticatedUser: ["GET /user/keys"],
+ setPrimaryEmailVisibilityForAuthenticated: [
+ "PATCH /user/email/visibility",
+ {},
+ { renamed: ["users", "setPrimaryEmailVisibilityForAuthenticatedUser"] },
+ ],
+ setPrimaryEmailVisibilityForAuthenticatedUser: [
+ "PATCH /user/email/visibility",
+ ],
unblock: ["DELETE /user/blocks/{username}"],
unfollow: ["DELETE /user/following/{username}"],
updateAuthenticated: ["PATCH /user"],
diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts
index d0ff3920b..f37a6cf86 100644
--- a/src/generated/method-types.ts
+++ b/src/generated/method-types.ts
@@ -563,6 +563,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
+ * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
+ * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
+ * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ */
+ downloadWorkflowRunAttemptLogs: {
+ (
+ params?: RestEndpointMethodTypes["actions"]["downloadWorkflowRunAttemptLogs"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["actions"]["downloadWorkflowRunAttemptLogs"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
* `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
@@ -850,6 +865,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Gets a specific workflow run attempt. Anyone with read access to the repository
+ * can use this endpoint. If the repository is private you must use an access token
+ * with the `repo` scope. GitHub Apps must have the `actions:read` permission to
+ * use this endpoint.
+ */
+ getWorkflowRunAttempt: {
+ (
+ params?: RestEndpointMethodTypes["actions"]["getWorkflowRunAttempt"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["actions"]["getWorkflowRunAttempt"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
@@ -1082,18 +1112,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Retry your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
- */
- retryWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["retryWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["retryWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Approve or reject pending deployments that are waiting on approval by a required reviewer.
*
@@ -1579,6 +1597,7 @@ export type RestEndpointMethods = {
* Add a single repository to an installation. The authenticated user must have admin access to the repository.
*
* You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ * @deprecated octokit.rest.apps.addRepoToInstallation() has been renamed to octokit.rest.apps.addRepoToInstallationForAuthenticatedUser() (2021-10-05)
*/
addRepoToInstallation: {
(
@@ -1589,6 +1608,20 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Add a single repository to an installation. The authenticated user must have admin access to the repository.
+ *
+ * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ */
+ addRepoToInstallationForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["apps"]["addRepoToInstallationForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["apps"]["addRepoToInstallationForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.
*/
@@ -2006,6 +2039,7 @@ export type RestEndpointMethods = {
* Remove a single repository from an installation. The authenticated user must have admin access to the repository.
*
* You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ * @deprecated octokit.rest.apps.removeRepoFromInstallation() has been renamed to octokit.rest.apps.removeRepoFromInstallationForAuthenticatedUser() (2021-10-05)
*/
removeRepoFromInstallation: {
(
@@ -2016,6 +2050,20 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Remove a single repository from an installation. The authenticated user must have admin access to the repository.
+ *
+ * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ */
+ removeRepoFromInstallationForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["apps"]["removeRepoFromInstallationForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["apps"]["removeRepoFromInstallationForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.
*/
@@ -2294,6 +2342,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ *
+ * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
+ */
+ rerequestRun: {
+ (
+ params?: RestEndpointMethodTypes["checks"]["rerequestRun"]["parameters"]
+ ): Promise;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
@@ -2443,9 +2503,6 @@ export type RestEndpointMethods = {
* the response contains the analysis data that was uploaded.
* This is formatted as
* [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
- *
- * **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.
*/
getAnalysis: {
(
@@ -4077,6 +4134,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists all the repositories for this user migration.
+ */
+ listReposForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["migrations"]["listReposForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["migrations"]["listReposForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* List all the repositories for this organization migration.
*/
@@ -4091,6 +4160,7 @@ export type RestEndpointMethods = {
};
/**
* Lists all the repositories for this user migration.
+ * @deprecated octokit.rest.migrations.listReposForUser() has been renamed to octokit.rest.migrations.listReposForAuthenticatedUser() (2021-10-05)
*/
listReposForUser: {
(
@@ -5946,6 +6016,9 @@ export type RestEndpointMethods = {
};
};
repos: {
+ /**
+ * @deprecated octokit.rest.repos.acceptInvitation() has been renamed to octokit.rest.repos.acceptInvitationForAuthenticatedUser() (2021-10-05)
+ */
acceptInvitation: {
(
params?: RestEndpointMethodTypes["repos"]["acceptInvitation"]["parameters"]
@@ -5955,6 +6028,16 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+
+ acceptInvitationForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["repos"]["acceptInvitationForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["repos"]["acceptInvitationForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -6460,7 +6543,9 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
-
+ /**
+ * @deprecated octokit.rest.repos.declineInvitation() has been renamed to octokit.rest.repos.declineInvitationForAuthenticatedUser() (2021-10-05)
+ */
declineInvitation: {
(
params?: RestEndpointMethodTypes["repos"]["declineInvitation"]["parameters"]
@@ -6470,6 +6555,16 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+
+ declineInvitationForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["repos"]["declineInvitationForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["repos"]["declineInvitationForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
*
@@ -6798,6 +6893,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
+ */
+ generateReleaseNotes: {
+ (
+ params?: RestEndpointMethodTypes["repos"]["generateReleaseNotes"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["repos"]["generateReleaseNotes"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* 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.
*/
@@ -8894,6 +9001,7 @@ export type RestEndpointMethods = {
users: {
/**
* This endpoint is accessible with the `user` scope.
+ * @deprecated octokit.rest.users.addEmailForAuthenticated() has been renamed to octokit.rest.users.addEmailForAuthenticatedUser() (2021-10-05)
*/
addEmailForAuthenticated: {
(
@@ -8904,6 +9012,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * This endpoint is accessible with the `user` scope.
+ */
+ addEmailForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["addEmailForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["addEmailForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
block: {
(
@@ -8942,6 +9062,7 @@ export type RestEndpointMethods = {
};
/**
* Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.createGpgKeyForAuthenticated() has been renamed to octokit.rest.users.createGpgKeyForAuthenticatedUser() (2021-10-05)
*/
createGpgKeyForAuthenticated: {
(
@@ -8952,8 +9073,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ createGpgKeyForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["createGpgKeyForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["createGpgKeyForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.createPublicSshKeyForAuthenticated() has been renamed to octokit.rest.users.createPublicSshKeyForAuthenticatedUser() (2021-10-05)
*/
createPublicSshKeyForAuthenticated: {
(
@@ -8964,8 +9098,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ createPublicSshKeyForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["createPublicSshKeyForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["createPublicSshKeyForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* This endpoint is accessible with the `user` scope.
+ * @deprecated octokit.rest.users.deleteEmailForAuthenticated() has been renamed to octokit.rest.users.deleteEmailForAuthenticatedUser() (2021-10-05)
*/
deleteEmailForAuthenticated: {
(
@@ -8976,8 +9123,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * This endpoint is accessible with the `user` scope.
+ */
+ deleteEmailForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["deleteEmailForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["deleteEmailForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.deleteGpgKeyForAuthenticated() has been renamed to octokit.rest.users.deleteGpgKeyForAuthenticatedUser() (2021-10-05)
*/
deleteGpgKeyForAuthenticated: {
(
@@ -8988,8 +9148,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ deleteGpgKeyForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["deleteGpgKeyForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["deleteGpgKeyForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.deletePublicSshKeyForAuthenticated() has been renamed to octokit.rest.users.deletePublicSshKeyForAuthenticatedUser() (2021-10-05)
*/
deletePublicSshKeyForAuthenticated: {
(
@@ -9000,6 +9173,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ deletePublicSshKeyForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["deletePublicSshKeyForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["deletePublicSshKeyForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
*
@@ -9063,6 +9248,7 @@ export type RestEndpointMethods = {
};
/**
* View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.getGpgKeyForAuthenticated() has been renamed to octokit.rest.users.getGpgKeyForAuthenticatedUser() (2021-10-05)
*/
getGpgKeyForAuthenticated: {
(
@@ -9073,8 +9259,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ getGpgKeyForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["getGpgKeyForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["getGpgKeyForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.getPublicSshKeyForAuthenticated() has been renamed to octokit.rest.users.getPublicSshKeyForAuthenticatedUser() (2021-10-05)
*/
getPublicSshKeyForAuthenticated: {
(
@@ -9085,6 +9284,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ getPublicSshKeyForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["getPublicSshKeyForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["getPublicSshKeyForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
*
@@ -9099,6 +9310,7 @@ export type RestEndpointMethods = {
};
/**
* List the users you've blocked on your personal account.
+ * @deprecated octokit.rest.users.listBlockedByAuthenticated() has been renamed to octokit.rest.users.listBlockedByAuthenticatedUser() (2021-10-05)
*/
listBlockedByAuthenticated: {
(
@@ -9109,8 +9321,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * List the users you've blocked on your personal account.
+ */
+ listBlockedByAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["listBlockedByAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["listBlockedByAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
+ * @deprecated octokit.rest.users.listEmailsForAuthenticated() has been renamed to octokit.rest.users.listEmailsForAuthenticatedUser() (2021-10-05)
*/
listEmailsForAuthenticated: {
(
@@ -9121,8 +9346,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.
+ */
+ listEmailsForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["listEmailsForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["listEmailsForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists the people who the authenticated user follows.
+ * @deprecated octokit.rest.users.listFollowedByAuthenticated() has been renamed to octokit.rest.users.listFollowedByAuthenticatedUser() (2021-10-05)
*/
listFollowedByAuthenticated: {
(
@@ -9133,6 +9371,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists the people who the authenticated user follows.
+ */
+ listFollowedByAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["listFollowedByAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["listFollowedByAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists the people following the authenticated user.
*/
@@ -9171,6 +9421,7 @@ export type RestEndpointMethods = {
};
/**
* Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.listGpgKeysForAuthenticated() has been renamed to octokit.rest.users.listGpgKeysForAuthenticatedUser() (2021-10-05)
*/
listGpgKeysForAuthenticated: {
(
@@ -9181,6 +9432,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ listGpgKeysForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["listGpgKeysForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["listGpgKeysForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists the GPG keys for a user. This information is accessible by anyone.
*/
@@ -9195,6 +9458,7 @@ export type RestEndpointMethods = {
};
/**
* Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
+ * @deprecated octokit.rest.users.listPublicEmailsForAuthenticated() has been renamed to octokit.rest.users.listPublicEmailsForAuthenticatedUser() (2021-10-05)
*/
listPublicEmailsForAuthenticated: {
(
@@ -9205,6 +9469,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.
+ */
+ listPublicEmailsForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["listPublicEmailsForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["listPublicEmailsForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists the _verified_ public SSH keys for a user. This is accessible by anyone.
*/
@@ -9219,6 +9495,7 @@ export type RestEndpointMethods = {
};
/**
* Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * @deprecated octokit.rest.users.listPublicSshKeysForAuthenticated() has been renamed to octokit.rest.users.listPublicSshKeysForAuthenticatedUser() (2021-10-05)
*/
listPublicSshKeysForAuthenticated: {
(
@@ -9229,8 +9506,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ */
+ listPublicSshKeysForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["listPublicSshKeysForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["listPublicSshKeysForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Sets the visibility for your primary email addresses.
+ * @deprecated octokit.rest.users.setPrimaryEmailVisibilityForAuthenticated() has been renamed to octokit.rest.users.setPrimaryEmailVisibilityForAuthenticatedUser() (2021-10-05)
*/
setPrimaryEmailVisibilityForAuthenticated: {
(
@@ -9241,6 +9531,18 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Sets the visibility for your primary email addresses.
+ */
+ setPrimaryEmailVisibilityForAuthenticatedUser: {
+ (
+ params?: RestEndpointMethodTypes["users"]["setPrimaryEmailVisibilityForAuthenticatedUser"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["users"]["setPrimaryEmailVisibilityForAuthenticatedUser"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
unblock: {
(
diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts
index 0b5b32883..0cf89f9c8 100644
--- a/src/generated/parameters-and-response-types.ts
+++ b/src/generated/parameters-and-response-types.ts
@@ -186,6 +186,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["response"];
};
+ downloadWorkflowRunAttemptLogs: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs"]["response"];
+ };
downloadWorkflowRunLogs: {
parameters: RequestParameters &
Omit<
@@ -362,6 +370,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"];
};
+ getWorkflowRunAttempt: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}"]["response"];
+ };
getWorkflowRunUsage: {
parameters: RequestParameters &
Omit<
@@ -506,14 +522,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"];
};
- retryWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry"]["response"];
- };
reviewPendingDeploymentsForRun: {
parameters: RequestParameters &
Omit<
@@ -830,6 +838,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
};
+ addRepoToInstallationForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
+ };
checkToken: {
parameters: RequestParameters &
Omit<
@@ -1078,6 +1094,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
};
+ removeRepoFromInstallationForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"];
+ };
resetToken: {
parameters: RequestParameters &
Omit<
@@ -1242,6 +1266,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"];
};
+ rerequestRun: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest"]["response"];
+ };
rerequestSuite: {
parameters: RequestParameters &
Omit<
@@ -2316,6 +2348,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/migrations"]["response"];
};
+ listReposForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/migrations/{migration_id}/repositories"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"];
+ };
listReposForOrg: {
parameters: RequestParameters &
Omit<
@@ -3538,6 +3578,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"];
};
+ acceptInvitationForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"];
+ };
addAppAccessRestrictions: {
parameters: RequestParameters &
Omit<
@@ -3754,6 +3802,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"];
};
+ declineInvitationForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"];
+ };
delete: {
parameters: RequestParameters &
Omit<
@@ -3962,6 +4018,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["response"];
};
+ generateReleaseNotes: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["POST /repos/{owner}/{repo}/releases/generate-notes"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["POST /repos/{owner}/{repo}/releases/generate-notes"]["response"];
+ };
get: {
parameters: RequestParameters &
Omit<
@@ -5170,6 +5234,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /user/emails"]["response"];
};
+ addEmailForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["POST /user/emails"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["POST /user/emails"]["response"];
+ };
block: {
parameters: RequestParameters &
Omit<
@@ -5210,6 +5282,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /user/gpg_keys"]["response"];
};
+ createGpgKeyForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["POST /user/gpg_keys"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["POST /user/gpg_keys"]["response"];
+ };
createPublicSshKeyForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5218,6 +5298,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /user/keys"]["response"];
};
+ createPublicSshKeyForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["POST /user/keys"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["POST /user/keys"]["response"];
+ };
deleteEmailForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5226,6 +5314,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /user/emails"]["response"];
};
+ deleteEmailForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /user/emails"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /user/emails"]["response"];
+ };
deleteGpgKeyForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5234,6 +5330,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"];
};
+ deleteGpgKeyForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"];
+ };
deletePublicSshKeyForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5242,6 +5346,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /user/keys/{key_id}"]["response"];
};
+ deletePublicSshKeyForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /user/keys/{key_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /user/keys/{key_id}"]["response"];
+ };
follow: {
parameters: RequestParameters &
Omit<
@@ -5282,6 +5394,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"];
};
+ getGpgKeyForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"];
+ };
getPublicSshKeyForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5290,6 +5410,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/keys/{key_id}"]["response"];
};
+ getPublicSshKeyForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/keys/{key_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/keys/{key_id}"]["response"];
+ };
list: {
parameters: RequestParameters &
Omit<
@@ -5306,6 +5434,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/blocks"]["response"];
};
+ listBlockedByAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/blocks"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/blocks"]["response"];
+ };
listEmailsForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5314,6 +5450,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/emails"]["response"];
};
+ listEmailsForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/emails"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/emails"]["response"];
+ };
listFollowedByAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5322,6 +5466,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/following"]["response"];
};
+ listFollowedByAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/following"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/following"]["response"];
+ };
listFollowersForAuthenticatedUser: {
parameters: RequestParameters &
Omit<
@@ -5354,6 +5506,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/gpg_keys"]["response"];
};
+ listGpgKeysForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/gpg_keys"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/gpg_keys"]["response"];
+ };
listGpgKeysForUser: {
parameters: RequestParameters &
Omit<
@@ -5370,6 +5530,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/public_emails"]["response"];
};
+ listPublicEmailsForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/public_emails"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/public_emails"]["response"];
+ };
listPublicKeysForUser: {
parameters: RequestParameters &
Omit<
@@ -5386,6 +5554,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /user/keys"]["response"];
};
+ listPublicSshKeysForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /user/keys"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /user/keys"]["response"];
+ };
setPrimaryEmailVisibilityForAuthenticated: {
parameters: RequestParameters &
Omit<
@@ -5394,6 +5570,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PATCH /user/email/visibility"]["response"];
};
+ setPrimaryEmailVisibilityForAuthenticatedUser: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PATCH /user/email/visibility"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PATCH /user/email/visibility"]["response"];
+ };
unblock: {
parameters: RequestParameters &
Omit<
From 997f7c9f2b4cfe5b34386851d66fbbe110fd70df Mon Sep 17 00:00:00 2001
From: Octokit Bot <33075676+octokitbot@users.noreply.github.com>
Date: Thu, 7 Oct 2021 19:18:43 +0000
Subject: [PATCH 2/2] WIP octokit/openapi updated
---
package-lock.json | 30 +++++++++++++++---------------
package.json | 2 +-
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index bdac4e57c..2c5018e6f 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
"version": "0.0.0-development",
"license": "MIT",
"dependencies": {
- "@octokit/types": "^6.31.3",
+ "@octokit/types": "^6.32.0",
"deprecation": "^2.3.1"
},
"devDependencies": {
@@ -2515,9 +2515,9 @@
}
},
"node_modules/@octokit/openapi-types": {
- "version": "10.6.4",
- "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.6.4.tgz",
- "integrity": "sha512-JVmwWzYTIs6jACYOwD6zu5rdrqGIYsiAsLzTCxdrWIPNKNVjEF6vPTL20shmgJ4qZsq7WPBcLXLsaQD+NLChfg=="
+ "version": "11.0.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.0.0.tgz",
+ "integrity": "sha512-QeMW4h18cEm53ojYufACSRgq3rrQg4BibVcsHytXmbJ+otmXSelr1BCBCEi8q7nqGkYJyGQX30DoULENIgJ8BA=="
},
"node_modules/@octokit/plugin-paginate-rest": {
"version": "2.16.7",
@@ -2591,11 +2591,11 @@
}
},
"node_modules/@octokit/types": {
- "version": "6.31.3",
- "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.31.3.tgz",
- "integrity": "sha512-IUG3uMpsLHrtEL6sCVXbxCgnbKcgpkS4K7gVEytLDvYYalkK3XcuMCHK1YPD8xJglSJAOAbL4MgXp47rS9G49w==",
+ "version": "6.32.0",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.32.0.tgz",
+ "integrity": "sha512-7CFlMfpX78PbvGnQZfQ3pD246RGTLITDnLCyYgTOtwNPIdTKMGs/8dJiZA3Fh5vXuZYqu/YHH32GboK7xnZ0ag==",
"dependencies": {
- "@octokit/openapi-types": "^10.6.4"
+ "@octokit/openapi-types": "^11.0.0"
}
},
"node_modules/@pika/babel-plugin-esm-import-rewrite": {
@@ -18944,9 +18944,9 @@
}
},
"@octokit/openapi-types": {
- "version": "10.6.4",
- "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.6.4.tgz",
- "integrity": "sha512-JVmwWzYTIs6jACYOwD6zu5rdrqGIYsiAsLzTCxdrWIPNKNVjEF6vPTL20shmgJ4qZsq7WPBcLXLsaQD+NLChfg=="
+ "version": "11.0.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-11.0.0.tgz",
+ "integrity": "sha512-QeMW4h18cEm53ojYufACSRgq3rrQg4BibVcsHytXmbJ+otmXSelr1BCBCEi8q7nqGkYJyGQX30DoULENIgJ8BA=="
},
"@octokit/plugin-paginate-rest": {
"version": "2.16.7",
@@ -19012,11 +19012,11 @@
}
},
"@octokit/types": {
- "version": "6.31.3",
- "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.31.3.tgz",
- "integrity": "sha512-IUG3uMpsLHrtEL6sCVXbxCgnbKcgpkS4K7gVEytLDvYYalkK3XcuMCHK1YPD8xJglSJAOAbL4MgXp47rS9G49w==",
+ "version": "6.32.0",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.32.0.tgz",
+ "integrity": "sha512-7CFlMfpX78PbvGnQZfQ3pD246RGTLITDnLCyYgTOtwNPIdTKMGs/8dJiZA3Fh5vXuZYqu/YHH32GboK7xnZ0ag==",
"requires": {
- "@octokit/openapi-types": "^10.6.4"
+ "@octokit/openapi-types": "^11.0.0"
}
},
"@pika/babel-plugin-esm-import-rewrite": {
diff --git a/package.json b/package.json
index 83b03ada8..7862456f4 100644
--- a/package.json
+++ b/package.json
@@ -24,7 +24,7 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"dependencies": {
- "@octokit/types": "^6.31.3",
+ "@octokit/types": "^6.32.0",
"deprecation": "^2.3.1"
},
"devDependencies": {
|