Skip to content

Commit 6867fec

Browse files
authored
fix: update descriptions and examples
1 parent ec64963 commit 6867fec

File tree

9 files changed

+97
-23
lines changed

9 files changed

+97
-23
lines changed

docs/activity/deleteThreadSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ octokit.rest.activity.deleteThreadSubscription({
2929
<tbody>
3030
<tr><td>thread_id</td><td>yes</td><td>
3131

32-
The unique identifier of the thread.
32+
The unique identifier of the pull request thread.
3333

3434
</td></tr>
3535
</tbody>

docs/activity/getThread.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ octokit.rest.activity.getThread({
2727
<tbody>
2828
<tr><td>thread_id</td><td>yes</td><td>
2929

30-
The unique identifier of the thread.
30+
The unique identifier of the pull request thread.
3131

3232
</td></tr>
3333
</tbody>

docs/activity/getThreadSubscriptionForAuthenticatedUser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ octokit.rest.activity.getThreadSubscriptionForAuthenticatedUser({
3131
<tbody>
3232
<tr><td>thread_id</td><td>yes</td><td>
3333

34-
The unique identifier of the thread.
34+
The unique identifier of the pull request thread.
3535

3636
</td></tr>
3737
</tbody>

docs/activity/markNotificationsAsRead.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ octokit.rest.activity.markNotificationsAsRead();
2727
<tbody>
2828
<tr><td>last_read_at</td><td>no</td><td>
2929

30-
Describes the last point that notifications were checked.
30+
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.
3131

3232
</td></tr>
3333
<tr><td>read</td><td>no</td><td>

docs/activity/markThreadAsRead.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ octokit.rest.activity.markThreadAsRead({
2727
<tbody>
2828
<tr><td>thread_id</td><td>yes</td><td>
2929

30-
The unique identifier of the thread.
30+
The unique identifier of the pull request thread.
3131

3232
</td></tr>
3333
</tbody>

docs/activity/setThreadSubscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ octokit.rest.activity.setThreadSubscription({
3333
<tbody>
3434
<tr><td>thread_id</td><td>yes</td><td>
3535

36-
The unique identifier of the thread.
36+
The unique identifier of the pull request thread.
3737

3838
</td></tr>
3939
<tr><td>ignored</td><td>no</td><td>

docs/repos/checkVulnerabilityAlerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type: API method
88

99
# Check if vulnerability alerts are enabled for a repository
1010

11-
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)".
11+
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)".
1212

1313
```js
1414
octokit.rest.repos.checkVulnerabilityAlerts({

scripts/update-endpoints/generated/endpoints.json

Lines changed: 89 additions & 15 deletions
Large diffs are not rendered by default.

src/generated/method-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7633,7 +7633,7 @@ export type RestEndpointMethods = {
76337633
endpoint: EndpointInterface<{ url: string }>;
76347634
};
76357635
/**
7636-
* 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)".
7636+
* 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)".
76377637
*/
76387638
checkVulnerabilityAlerts: {
76397639
(

0 commit comments

Comments
 (0)