Skip to content

fix: improved endpoint parameters and response types via @octokit/types@6.8.4 / @octokit/openapi-types@4.0.3 #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 12, 2021
Merged

fix: improved endpoint parameters and response types via @octokit/types@6.8.4 / @octokit/openapi-types@4.0.3 #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/pulls/createReviewComment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Create a review comment for a pull request
example: octokit.pulls.createReviewComment({ owner, repo, pull_number, body, path })
example: octokit.pulls.createReviewComment({ owner, repo, pull_number, body })
route: POST /repos/{owner}/{repo}/pulls/{pull_number}/comments
scope: pulls
type: API method
Expand All @@ -22,7 +22,6 @@ octokit.pulls.createReviewComment({
repo,
pull_number,
body,
path,
});
```

Expand Down Expand Up @@ -56,7 +55,7 @@ The text of the review comment.
The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.

</td></tr>
<tr><td>path</td><td>yes</td><td>
<tr><td>path</td><td>no</td><td>

The relative path to the file that necessitates a comment.

Expand Down
5 changes: 3 additions & 2 deletions docs/pulls/removeRequestedReviewers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Remove requested reviewers from a pull request
example: octokit.pulls.removeRequestedReviewers({ owner, repo, pull_number })
example: octokit.pulls.removeRequestedReviewers({ owner, repo, pull_number, reviewers })
route: DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
scope: pulls
type: API method
Expand All @@ -13,6 +13,7 @@ octokit.pulls.removeRequestedReviewers({
owner,
repo,
pull_number,
reviewers,
});
```

Expand All @@ -36,7 +37,7 @@ octokit.pulls.removeRequestedReviewers({
<tr><td>pull_number</td><td>yes</td><td>

</td></tr>
<tr><td>reviewers</td><td>no</td><td>
<tr><td>reviewers</td><td>yes</td><td>

An array of user `login`s that will be removed.

Expand Down
5 changes: 2 additions & 3 deletions docs/teams/updateInOrg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Update a team
example: octokit.teams.updateInOrg({ org, team_slug, name })
example: octokit.teams.updateInOrg({ org, team_slug })
route: PATCH /orgs/{org}/teams/{team_slug}
scope: teams
type: API method
Expand All @@ -16,7 +16,6 @@ To edit a team, the authenticated user must either be an organization owner or a
octokit.teams.updateInOrg({
org,
team_slug,
name,
});
```

Expand All @@ -39,7 +38,7 @@ octokit.teams.updateInOrg({
team_slug parameter

</td></tr>
<tr><td>name</td><td>yes</td><td>
<tr><td>name</td><td>no</td><td>

The name of the team.

Expand Down
12 changes: 6 additions & 6 deletions scripts/update-endpoints/generated/endpoints.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18329,7 +18329,7 @@
"type": null,
"required": false,
"enum": null,
"allowNull": false,
"allowNull": true,
"mapToData": null,
"validation": null,
"alias": null,
Expand All @@ -18342,7 +18342,7 @@
"type": "string",
"required": false,
"enum": null,
"allowNull": false,
"allowNull": true,
"mapToData": null,
"validation": null,
"alias": null,
Expand Down Expand Up @@ -26432,7 +26432,7 @@
"description": "The relative path to the file that necessitates a comment.",
"in": "BODY",
"type": "string",
"required": true,
"required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
Expand Down Expand Up @@ -28062,7 +28062,7 @@
"description": "An array of user `login`s that will be removed.",
"in": "BODY",
"type": "string[]",
"required": false,
"required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
Expand Down Expand Up @@ -48393,7 +48393,7 @@
"description": "The name of the team.",
"in": "BODY",
"type": "string",
"required": true,
"required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
Expand Down Expand Up @@ -48447,7 +48447,7 @@
"type": "integer",
"required": false,
"enum": null,
"allowNull": false,
"allowNull": true,
"mapToData": null,
"validation": null,
"alias": null,
Expand Down