Skip to content

Commit c00f839

Browse files
fix(typescript): method description updates (#112)
Co-authored-by: Octokit Bot <33075676+octokitbot@users.noreply.github.com>
1 parent ec98609 commit c00f839

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

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 vulnerability 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
1212

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

docs/repos/disableVulnerabilityAlerts.md

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

99
# Disable vulnerability alerts
1010

11-
Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
11+
Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
1212

1313
```js
1414
octokit.repos.disableVulnerabilityAlerts({

docs/repos/enableVulnerabilityAlerts.md

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

99
# Enable vulnerability alerts
1010

11-
Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
11+
Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
1212

1313
```js
1414
octokit.repos.enableVulnerabilityAlerts({

scripts/update-endpoints/generated/endpoints.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38770,7 +38770,7 @@
3877038770
"url": "/repos/{owner}/{repo}/vulnerability-alerts",
3877138771
"isDeprecated": false,
3877238772
"isLegacy": false,
38773-
"description": "Shows whether vulnerability 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.",
38773+
"description": "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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.",
3877438774
"documentationUrl": "https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository",
3877538775
"previews": [{ "name": "dorian" }],
3877638776
"headers": [
@@ -38819,7 +38819,7 @@
3881938819
"url": "/repos/{owner}/{repo}/vulnerability-alerts",
3882038820
"isDeprecated": false,
3882138821
"isLegacy": false,
38822-
"description": "Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.",
38822+
"description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.",
3882338823
"documentationUrl": "https://developer.github.com/v3/repos/#enable-vulnerability-alerts",
3882438824
"previews": [{ "name": "dorian" }],
3882538825
"headers": [
@@ -38868,7 +38868,7 @@
3886838868
"url": "/repos/{owner}/{repo}/vulnerability-alerts",
3886938869
"isDeprecated": false,
3887038870
"isLegacy": false,
38871-
"description": "Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.",
38871+
"description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.",
3887238872
"documentationUrl": "https://developer.github.com/v3/repos/#disable-vulnerability-alerts",
3887338873
"previews": [{ "name": "dorian" }],
3887438874
"headers": [

src/generated/method-types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4930,7 +4930,7 @@ export type RestEndpointMethods = {
49304930
endpoint: EndpointInterface<{ url: string }>;
49314931
};
49324932
/**
4933-
* Shows whether vulnerability 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
4933+
* 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
49344934
*/
49354935
checkVulnerabilityAlerts: {
49364936
(
@@ -5326,7 +5326,7 @@ export type RestEndpointMethods = {
53265326
endpoint: EndpointInterface<{ url: string }>;
53275327
};
53285328
/**
5329-
* Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
5329+
* Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
53305330
*/
53315331
disableVulnerabilityAlerts: {
53325332
(
@@ -5360,7 +5360,7 @@ export type RestEndpointMethods = {
53605360
endpoint: EndpointInterface<{ url: string }>;
53615361
};
53625362
/**
5363-
* Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
5363+
* Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation.
53645364
*/
53655365
enableVulnerabilityAlerts: {
53665366
(

0 commit comments

Comments
 (0)