Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
fix: update descriptions and examples
  • Loading branch information
octokitbot committed Jun 20, 2022
1 parent ec64963 commit 6867fec
Show file tree
Hide file tree
Showing 9 changed files with 97 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/activity/deleteThreadSubscription.md
Expand Up @@ -29,7 +29,7 @@ octokit.rest.activity.deleteThreadSubscription({
<tbody>
<tr><td>thread_id</td><td>yes</td><td>

The unique identifier of the thread.
The unique identifier of the pull request thread.

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/activity/getThread.md
Expand Up @@ -27,7 +27,7 @@ octokit.rest.activity.getThread({
<tbody>
<tr><td>thread_id</td><td>yes</td><td>

The unique identifier of the thread.
The unique identifier of the pull request thread.

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/activity/getThreadSubscriptionForAuthenticatedUser.md
Expand Up @@ -31,7 +31,7 @@ octokit.rest.activity.getThreadSubscriptionForAuthenticatedUser({
<tbody>
<tr><td>thread_id</td><td>yes</td><td>

The unique identifier of the thread.
The unique identifier of the pull request thread.

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/activity/markNotificationsAsRead.md
Expand Up @@ -27,7 +27,7 @@ octokit.rest.activity.markNotificationsAsRead();
<tbody>
<tr><td>last_read_at</td><td>no</td><td>

Describes the last point that notifications were checked.
Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.

</td></tr>
<tr><td>read</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/activity/markThreadAsRead.md
Expand Up @@ -27,7 +27,7 @@ octokit.rest.activity.markThreadAsRead({
<tbody>
<tr><td>thread_id</td><td>yes</td><td>

The unique identifier of the thread.
The unique identifier of the pull request thread.

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/activity/setThreadSubscription.md
Expand Up @@ -33,7 +33,7 @@ octokit.rest.activity.setThreadSubscription({
<tbody>
<tr><td>thread_id</td><td>yes</td><td>

The unique identifier of the thread.
The unique identifier of the pull request thread.

</td></tr>
<tr><td>ignored</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/repos/checkVulnerabilityAlerts.md
Expand Up @@ -8,7 +8,7 @@ type: API method

# Check if vulnerability alerts are enabled for a repository

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".

```js
octokit.rest.repos.checkVulnerabilityAlerts({
Expand Down
104 changes: 89 additions & 15 deletions scripts/update-endpoints/generated/endpoints.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/generated/method-types.ts
Expand Up @@ -7633,7 +7633,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
* Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
* Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
*/
checkVulnerabilityAlerts: {
(
Expand Down

0 comments on commit 6867fec

Please sign in to comment.