Skip to content

Commit b641391

Browse files
authored
fix: enable giant-sentry-fist preview for octokit.orgs.blockUser / octokit.orgs.checkBlockedUser / octokit.orgs.listBlockedUsers / octokit.orgs.unblockUser / octokit.users.block / octokit.users.checkBlocked / octokit.users.listBlockedByAuthenticated / octokit.users.unblock (#313)
1 parent 00c07cc commit b641391

20 files changed

+129
-306
lines changed

docs/apps/suspendInstallation.md

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

1313
Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
1414

15-
To suspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed.
16-
1715
You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
1816

1917
```js

docs/apps/unsuspendInstallation.md

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

1313
Removes a GitHub App installation suspension.
1414

15-
To unsuspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed and suspended.
16-
1715
You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
1816

1917
```js

docs/billing/getGithubActionsBillingOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gets the summary of the free and paid GitHub Actions minutes used.
1212

1313
Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
1414

15-
Access tokens must have the `read:org` scope.
15+
Access tokens must have the `repo` or `admin:org` scope.
1616

1717
```js
1818
octokit.billing.getGithubActionsBillingOrg({

docs/billing/getGithubPackagesBillingOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gets the free and paid storage usued for GitHub Packages in gigabytes.
1212

1313
Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
1414

15-
Access tokens must have the `read:org` scope.
15+
Access tokens must have the `repo` or `admin:org` scope.
1616

1717
```js
1818
octokit.billing.getGithubPackagesBillingOrg({

docs/billing/getSharedStorageBillingOrg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gets the estimated paid and estimated total storage used for GitHub Actions and
1212

1313
Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
1414

15-
Access tokens must have the `read:org` scope.
15+
Access tokens must have the `repo` or `admin:org` scope.
1616

1717
```js
1818
octokit.billing.getSharedStorageBillingOrg({

docs/codeScanning/listAlertsForRepo.md

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

99
# List code scanning alerts for a repository
1010

11-
Lists all open code scanning alerts for the default branch (usually `main` or `master`). For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint.
11+
Lists all open code scanning alerts for the default branch (usually `main` or `master`). You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.
1212

1313
```js
1414
octokit.codeScanning.listAlertsForRepo({

docs/codeScanning/listRecentAnalyses.md

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

99
# List recent code scanning analyses for a repository
1010

11-
List the details of recent code scanning analyses for a repository. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint.
11+
List the details of recent code scanning analyses for a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.
1212

1313
```js
1414
octokit.codeScanning.listRecentAnalyses({

docs/codeScanning/updateAlert.md

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

99
# Update a code scanning alert
1010

11-
Updates the status of a single code scanning alert. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes.
12-
GitHub Apps must have the `security_events` write permission to use this endpoint.
11+
Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.
1312

1413
```js
1514
octokit.codeScanning.updateAlert({

docs/codeScanning/uploadSarif.md

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

99
# Upload a SARIF file
1010

11-
Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository.
12-
For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` write permission to use this endpoint.
11+
Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.
1312

1413
```js
1514
octokit.codeScanning.uploadSarif({

docs/git/createTree.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ The content you want this file to have. GitHub will write this blob out and use
7373
</td></tr>
7474
<tr><td>base_tree</td><td>no</td><td>
7575

76-
The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.
76+
The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.
77+
If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.
7778

7879
</td></tr>
7980
</tbody>

docs/pulls/createReviewComment.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,14 @@ type: API method
88

99
# Create a review comment for a pull request
1010

11-
**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.
12-
1311
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.
1412

15-
You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://docs.github.com/rest/reference/pulls#multi-line-comment-summary-3).
13+
You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).
1614

1715
**Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
1816

1917
This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.
2018

21-
**Multi-line comment summary**
22-
23-
**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.
24-
25-
Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.
26-
27-
If you use the `comfort-fade` preview header, your response will show:
28-
29-
- For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.
30-
- For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.
31-
32-
If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:
33-
34-
- For multi-line comments, the last line of the comment range for the `position` attribute.
35-
- For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.
36-
3719
```js
3820
octokit.pulls.createReviewComment({
3921
owner,

docs/pulls/getReviewComment.md

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

99
# Get a review comment for a pull request
1010

11-
**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.
12-
1311
Provides details for a review comment.
1412

15-
**Multi-line comment summary**
16-
17-
**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.
18-
19-
Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.
20-
21-
If you use the `comfort-fade` preview header, your response will show:
22-
23-
- For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.
24-
- For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.
25-
26-
If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:
27-
28-
- For multi-line comments, the last line of the comment range for the `position` attribute.
29-
- For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.
30-
31-
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.
32-
3313
```js
3414
octokit.pulls.getReviewComment({
3515
owner,

docs/pulls/listReviewComments.md

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

99
# List review comments on a pull request
1010

11-
**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.
12-
1311
Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
1412

15-
**Multi-line comment summary**
16-
17-
**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.
18-
19-
Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.
20-
21-
If you use the `comfort-fade` preview header, your response will show:
22-
23-
- For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.
24-
- For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.
25-
26-
If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:
27-
28-
- For multi-line comments, the last line of the comment range for the `position` attribute.
29-
- For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.
30-
31-
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.
32-
3313
```js
3414
octokit.pulls.listReviewComments({
3515
owner,

docs/pulls/listReviewCommentsForRepo.md

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

99
# List review comments in a repository
1010

11-
**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.
12-
1311
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
1412

15-
**Multi-line comment summary**
16-
17-
**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.
18-
19-
Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.
20-
21-
If you use the `comfort-fade` preview header, your response will show:
22-
23-
- For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.
24-
- For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.
25-
26-
If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:
27-
28-
- For multi-line comments, the last line of the comment range for the `position` attribute.
29-
- For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.
30-
31-
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.
32-
3313
```js
3414
octokit.pulls.listReviewCommentsForRepo({
3515
owner,

docs/pulls/updateReviewComment.md

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

99
# Update a review comment for a pull request
1010

11-
**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.
12-
1311
Enables you to edit a review comment.
1412

15-
**Multi-line comment summary**
16-
17-
**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.
18-
19-
Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.
20-
21-
If you use the `comfort-fade` preview header, your response will show:
22-
23-
- For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.
24-
- For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.
25-
26-
If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:
27-
28-
- For multi-line comments, the last line of the comment range for the `position` attribute.
29-
- For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/rest/reference/pulls#parameters-2) table.
30-
3113
```js
3214
octokit.pulls.updateReviewComment({
3315
owner,

docs/repos/getContent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ type: API method
99
# Get repository content
1010

1111
Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit
12-
`:path`, you will receive the contents of all files in the repository.
12+
`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
1313

1414
Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for
1515
retrieving the raw content or rendered HTML (when supported). All content types support [a custom media

docs/users/checkBlocked.md

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

99
# Check if a user is blocked by the authenticated user
1010

11-
If the user is blocked:
12-
13-
If the user is not blocked:
14-
1511
```js
1612
octokit.users.checkBlocked({
1713
username,

0 commit comments

Comments
 (0)