Skip to content

Commit fa85f0f

Browse files
authored
fix: improved endpoint parameters and response types via @octokit/types@6.8.4 / @octokit/openapi-types@4.0.3 (#342)
1 parent b409fc6 commit fa85f0f

File tree

4 files changed

+13
-14
lines changed

4 files changed

+13
-14
lines changed

docs/pulls/createReviewComment.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Create a review comment for a pull request
3-
example: octokit.pulls.createReviewComment({ owner, repo, pull_number, body, path })
3+
example: octokit.pulls.createReviewComment({ owner, repo, pull_number, body })
44
route: POST /repos/{owner}/{repo}/pulls/{pull_number}/comments
55
scope: pulls
66
type: API method
@@ -22,7 +22,6 @@ octokit.pulls.createReviewComment({
2222
repo,
2323
pull_number,
2424
body,
25-
path,
2625
});
2726
```
2827

@@ -56,7 +55,7 @@ The text of the review comment.
5655
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`.
5756

5857
</td></tr>
59-
<tr><td>path</td><td>yes</td><td>
58+
<tr><td>path</td><td>no</td><td>
6059

6160
The relative path to the file that necessitates a comment.
6261

docs/pulls/removeRequestedReviewers.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Remove requested reviewers from a pull request
3-
example: octokit.pulls.removeRequestedReviewers({ owner, repo, pull_number })
3+
example: octokit.pulls.removeRequestedReviewers({ owner, repo, pull_number, reviewers })
44
route: DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
55
scope: pulls
66
type: API method
@@ -13,6 +13,7 @@ octokit.pulls.removeRequestedReviewers({
1313
owner,
1414
repo,
1515
pull_number,
16+
reviewers,
1617
});
1718
```
1819

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

3839
</td></tr>
39-
<tr><td>reviewers</td><td>no</td><td>
40+
<tr><td>reviewers</td><td>yes</td><td>
4041

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

docs/teams/updateInOrg.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Update a team
3-
example: octokit.teams.updateInOrg({ org, team_slug, name })
3+
example: octokit.teams.updateInOrg({ org, team_slug })
44
route: PATCH /orgs/{org}/teams/{team_slug}
55
scope: teams
66
type: API method
@@ -16,7 +16,6 @@ To edit a team, the authenticated user must either be an organization owner or a
1616
octokit.teams.updateInOrg({
1717
org,
1818
team_slug,
19-
name,
2019
});
2120
```
2221

@@ -39,7 +38,7 @@ octokit.teams.updateInOrg({
3938
team_slug parameter
4039

4140
</td></tr>
42-
<tr><td>name</td><td>yes</td><td>
41+
<tr><td>name</td><td>no</td><td>
4342

4443
The name of the team.
4544

scripts/update-endpoints/generated/endpoints.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18329,7 +18329,7 @@
1832918329
"type": null,
1833018330
"required": false,
1833118331
"enum": null,
18332-
"allowNull": false,
18332+
"allowNull": true,
1833318333
"mapToData": null,
1833418334
"validation": null,
1833518335
"alias": null,
@@ -18342,7 +18342,7 @@
1834218342
"type": "string",
1834318343
"required": false,
1834418344
"enum": null,
18345-
"allowNull": false,
18345+
"allowNull": true,
1834618346
"mapToData": null,
1834718347
"validation": null,
1834818348
"alias": null,
@@ -26432,7 +26432,7 @@
2643226432
"description": "The relative path to the file that necessitates a comment.",
2643326433
"in": "BODY",
2643426434
"type": "string",
26435-
"required": true,
26435+
"required": false,
2643626436
"enum": null,
2643726437
"allowNull": false,
2643826438
"mapToData": null,
@@ -28062,7 +28062,7 @@
2806228062
"description": "An array of user `login`s that will be removed.",
2806328063
"in": "BODY",
2806428064
"type": "string[]",
28065-
"required": false,
28065+
"required": true,
2806628066
"enum": null,
2806728067
"allowNull": false,
2806828068
"mapToData": null,
@@ -48393,7 +48393,7 @@
4839348393
"description": "The name of the team.",
4839448394
"in": "BODY",
4839548395
"type": "string",
48396-
"required": true,
48396+
"required": false,
4839748397
"enum": null,
4839848398
"allowNull": false,
4839948399
"mapToData": null,
@@ -48447,7 +48447,7 @@
4844748447
"type": "integer",
4844848448
"required": false,
4844948449
"enum": null,
48450-
"allowNull": false,
48450+
"allowNull": true,
4845148451
"mapToData": null,
4845248452
"validation": null,
4845348453
"alias": null,

0 commit comments

Comments
 (0)