Skip to content

Commit 2613fa2

Browse files
committed
chore: update generated Markdown docs
1 parent 2b3ccc5 commit 2613fa2

File tree

94 files changed

+645
-122
lines changed

Some content is hidden

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

94 files changed

+645
-122
lines changed

docs/actions/createOrUpdateEnvironmentSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ The unique identifier of the repository.
111111
</td></tr>
112112
<tr><td>environment_name</td><td>yes</td><td>
113113

114-
The name of the environment
114+
The name of the environment.
115115

116116
</td></tr>
117117
<tr><td>secret_name</td><td>yes</td><td>

docs/actions/deleteEnvironmentSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The unique identifier of the repository.
3636
</td></tr>
3737
<tr><td>environment_name</td><td>yes</td><td>
3838

39-
The name of the environment
39+
The name of the environment.
4040

4141
</td></tr>
4242
<tr><td>secret_name</td><td>yes</td><td>

docs/actions/getEnvironmentPublicKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The unique identifier of the repository.
3535
</td></tr>
3636
<tr><td>environment_name</td><td>yes</td><td>
3737

38-
The name of the environment
38+
The name of the environment.
3939

4040
</td></tr>
4141
</tbody>

docs/actions/getEnvironmentSecret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The unique identifier of the repository.
3636
</td></tr>
3737
<tr><td>environment_name</td><td>yes</td><td>
3838

39-
The name of the environment
39+
The name of the environment.
4040

4141
</td></tr>
4242
<tr><td>secret_name</td><td>yes</td><td>

docs/actions/listEnvironmentSecrets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The unique identifier of the repository.
3535
</td></tr>
3636
<tr><td>environment_name</td><td>yes</td><td>
3737

38-
The name of the environment
38+
The name of the environment.
3939

4040
</td></tr>
4141
<tr><td>per_page</td><td>no</td><td>

docs/actions/listWorkflowRuns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Returns workflow run triggered by the event you specify. For example, `push`, `p
6363
</td></tr>
6464
<tr><td>status</td><td>no</td><td>
6565

66-
Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)."
66+
Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.
6767

6868
</td></tr>
6969
<tr><td>per_page</td><td>no</td><td>

docs/actions/listWorkflowRunsForRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Returns workflow run triggered by the event you specify. For example, `push`, `p
5757
</td></tr>
5858
<tr><td>status</td><td>no</td><td>
5959

60-
Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)."
60+
Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.
6161

6262
</td></tr>
6363
<tr><td>per_page</td><td>no</td><td>

docs/activity/listNotificationsForAuthenticatedUser.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ Only show notifications updated after the given time. This is a timestamp in [IS
4545
Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
4646

4747
</td></tr>
48-
<tr><td>per_page</td><td>no</td><td>
48+
<tr><td>page</td><td>no</td><td>
4949

50-
The number of results per page (max 100).
50+
Page number of the results to fetch.
5151

5252
</td></tr>
53-
<tr><td>page</td><td>no</td><td>
53+
<tr><td>per_page</td><td>no</td><td>
5454

55-
Page number of the results to fetch.
55+
The number of results per page (max 50).
5656

5757
</td></tr>
5858
</tbody>

docs/codeScanning/listAlertsForOrg.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Lists code scanning alerts for the default branch for all eligible repositories
1212

1313
To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
1414

15+
For public repositories, you may instead use the `public_repo` scope.
16+
1517
GitHub Apps must have the `security_events` read permission to use this endpoint.
1618

1719
```js

docs/gists/fork.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ type: API method
88

99
# Fork a gist
1010

11-
**Note**: This was previously `/gists/:gist_id/fork`.
12-
1311
```js
1412
octokit.rest.gists.fork({
1513
gist_id,

0 commit comments

Comments
 (0)