Skip to content

Commit a7ff767

Browse files
authored
fix(typescript): update documentation on endpoints (#639)
WIP octokit/openapi updated
1 parent 6ab7627 commit a7ff767

File tree

11 files changed

+9456
-41486
lines changed

11 files changed

+9456
-41486
lines changed

docs/pulls/checkIfMerged.md

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

99
# Check if a pull request has been merged
1010

11+
Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
12+
1113
```js
1214
octokit.rest.pulls.checkIfMerged({
1315
owner,

docs/pulls/deletePendingReview.md

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

99
# Delete a pending review for a pull request
1010

11+
Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
12+
1113
```js
1214
octokit.rest.pulls.deletePendingReview({
1315
owner,

docs/pulls/getReview.md

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

99
# Get a review for a pull request
1010

11+
Retrieves a pull request review by its ID.
12+
1113
```js
1214
octokit.rest.pulls.getReview({
1315
owner,

docs/pulls/merge.md

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

99
# Merge a pull request
1010

11+
Merges a pull request into the base branch.
1112
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
1213

1314
```js

docs/pulls/removeRequestedReviewers.md

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

99
# Remove requested reviewers from a pull request
1010

11+
Removes review requests from a pull request for a given set of users and/or teams.
12+
1113
```js
1214
octokit.rest.pulls.removeRequestedReviewers({
1315
owner,

docs/repos/getLatestPagesBuild.md

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

99
# Get latest Pages build
1010

11+
Gets information about the single most recent build of a GitHub Pages site.
12+
13+
A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
14+
1115
```js
1216
octokit.rest.repos.getLatestPagesBuild({
1317
owner,

docs/repos/getPages.md

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

99
# Get a GitHub Pages site
1010

11+
Gets information about a GitHub Pages site.
12+
13+
A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
14+
1115
```js
1216
octokit.rest.repos.getPages({
1317
owner,

docs/repos/getPagesBuild.md

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

99
# Get GitHub Pages build
1010

11+
Gets information about a GitHub Pages build.
12+
13+
A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
14+
1115
```js
1216
octokit.rest.repos.getPagesBuild({
1317
owner,

docs/repos/listPagesBuilds.md

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

99
# List GitHub Pages builds
1010

11+
Lists builts of a GitHub Pages site.
12+
13+
A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
14+
1115
```js
1216
octokit.rest.repos.listPagesBuilds({
1317
owner,

scripts/update-endpoints/generated/endpoints.json

Lines changed: 9398 additions & 41479 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)