Skip to content

Commit ac3bfbc

Browse files
authored
fix(typescript): description update (#318)
1 parent 90eddf1 commit ac3bfbc

File tree

7 files changed

+504
-38
lines changed

7 files changed

+504
-38
lines changed

docs/apps/createInstallationAccessToken.md

Lines changed: 139 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,157 @@ List of repository IDs that the token should have access to
4646
</td></tr>
4747
<tr><td>permissions</td><td>no</td><td>
4848

49+
The permissions granted to the user-to-server access token.
50+
51+
</td></tr>
52+
<tr><td>permissions.actions</td><td>no</td><td>
53+
54+
The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.
55+
56+
</td></tr>
57+
<tr><td>permissions.administration</td><td>no</td><td>
58+
59+
The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.
60+
61+
</td></tr>
62+
<tr><td>permissions.checks</td><td>no</td><td>
63+
64+
The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.
65+
66+
</td></tr>
67+
<tr><td>permissions.content_references</td><td>no</td><td>
68+
69+
The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.
70+
4971
</td></tr>
5072
<tr><td>permissions.contents</td><td>no</td><td>
5173

74+
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.
75+
76+
</td></tr>
77+
<tr><td>permissions.deployments</td><td>no</td><td>
78+
79+
The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.
80+
81+
</td></tr>
82+
<tr><td>permissions.environments</td><td>no</td><td>
83+
84+
The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.
85+
5286
</td></tr>
5387
<tr><td>permissions.issues</td><td>no</td><td>
5488

89+
The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.
90+
5591
</td></tr>
56-
<tr><td>permissions.deployments</td><td>no</td><td>
92+
<tr><td>permissions.metadata</td><td>no</td><td>
93+
94+
The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.
95+
96+
</td></tr>
97+
<tr><td>permissions.packages</td><td>no</td><td>
98+
99+
The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.
100+
101+
</td></tr>
102+
<tr><td>permissions.pages</td><td>no</td><td>
103+
104+
The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.
105+
106+
</td></tr>
107+
<tr><td>permissions.pull_requests</td><td>no</td><td>
108+
109+
The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.
110+
111+
</td></tr>
112+
<tr><td>permissions.repository_hooks</td><td>no</td><td>
113+
114+
The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.
115+
116+
</td></tr>
117+
<tr><td>permissions.repository_projects</td><td>no</td><td>
118+
119+
The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.
120+
121+
</td></tr>
122+
<tr><td>permissions.secret_scanning_alerts</td><td>no</td><td>
123+
124+
The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.
125+
126+
</td></tr>
127+
<tr><td>permissions.secrets</td><td>no</td><td>
128+
129+
The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.
130+
131+
</td></tr>
132+
<tr><td>permissions.security_events</td><td>no</td><td>
133+
134+
The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.
57135

58136
</td></tr>
59137
<tr><td>permissions.single_file</td><td>no</td><td>
60138

139+
The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.
140+
61141
</td></tr>
62-
<tr><td>permissions.def_not_a_repo</td><td>no</td><td>
142+
<tr><td>permissions.statuses</td><td>no</td><td>
143+
144+
The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.
145+
146+
</td></tr>
147+
<tr><td>permissions.vulnerability_alerts</td><td>no</td><td>
148+
149+
The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.
150+
151+
</td></tr>
152+
<tr><td>permissions.workflows</td><td>no</td><td>
153+
154+
The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.
155+
156+
</td></tr>
157+
<tr><td>permissions.members</td><td>no</td><td>
158+
159+
The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.
160+
161+
</td></tr>
162+
<tr><td>permissions.organization_administration</td><td>no</td><td>
163+
164+
The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.
165+
166+
</td></tr>
167+
<tr><td>permissions.organization_hooks</td><td>no</td><td>
168+
169+
The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.
170+
171+
</td></tr>
172+
<tr><td>permissions.organization_plan</td><td>no</td><td>
173+
174+
The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.
175+
176+
</td></tr>
177+
<tr><td>permissions.organization_projects</td><td>no</td><td>
178+
179+
The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.
180+
181+
</td></tr>
182+
<tr><td>permissions.organization_secrets</td><td>no</td><td>
183+
184+
The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.
185+
186+
</td></tr>
187+
<tr><td>permissions.organization_self_hosted_runners</td><td>no</td><td>
188+
189+
The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.
190+
191+
</td></tr>
192+
<tr><td>permissions.organization_user_blocking</td><td>no</td><td>
193+
194+
The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.
195+
196+
</td></tr>
197+
<tr><td>permissions.team_discussions</td><td>no</td><td>
198+
199+
The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.
63200

64201
</td></tr>
65202
</tbody>

docs/meta/get.md

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

99
# Get GitHub meta information
1010

11-
This endpoint provides a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)."
11+
Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)."
12+
13+
**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
1214

1315
```js
1416
octokit.meta.get();

docs/migrations/getImportStatus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ An import that does not have errors will progress through these steps:
2525
If there are problems, you will see one of these in the `status` field:
2626

2727
- `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
28-
- `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.
28+
- `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.
2929
- `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
3030
- `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL.
3131
- `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.

docs/repos/createFork.md

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

1111
Create a fork for the authenticated user.
1212

13-
**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).
13+
**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).
1414

1515
```js
1616
octokit.repos.createFork({

docs/repos/uploadReleaseAsset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ When an upstream failure occurs, you will receive a `502 Bad Gateway` status. Th
2525
**Notes:**
2626

2727
- GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)"
28-
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://github.com/contact).
28+
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact).
2929
- If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
3030

3131
```js

0 commit comments

Comments
 (0)