Skip to content

Commit 33f2e49

Browse files
authored
fix: update docs to reflect new request parameters in 3 APIs and updated API descriptions (#541)
WIP octokit/openapi updated
1 parent f690558 commit 33f2e49

File tree

10 files changed

+151
-58
lines changed

10 files changed

+151
-58
lines changed

docs/apps/createInstallationAccessToken.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,6 @@ The level of permission to grant the access token for checks on code.
6868

6969
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
7070

71-
</td></tr>
72-
<tr><td>permissions.organization_custom_roles</td><td>no</td><td>
73-
74-
The level of permission to grant the access token for custom roles management.
75-
7671
</td></tr>
7772
<tr><td>permissions.deployments</td><td>no</td><td>
7873

@@ -163,6 +158,11 @@ The level of permission to grant the access token for organization teams and mem
163158

164159
The level of permission to grant the access token to manage access to an organization.
165160

161+
</td></tr>
162+
<tr><td>permissions.organization_custom_roles</td><td>no</td><td>
163+
164+
The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.
165+
166166
</td></tr>
167167
<tr><td>permissions.organization_hooks</td><td>no</td><td>
168168

docs/apps/scopeToken.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,6 @@ The level of permission to grant the access token for checks on code.
8282

8383
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
8484

85-
</td></tr>
86-
<tr><td>permissions.organization_custom_roles</td><td>no</td><td>
87-
88-
The level of permission to grant the access token for custom roles management.
89-
9085
</td></tr>
9186
<tr><td>permissions.deployments</td><td>no</td><td>
9287

@@ -177,6 +172,11 @@ The level of permission to grant the access token for organization teams and mem
177172

178173
The level of permission to grant the access token to manage access to an organization.
179174

175+
</td></tr>
176+
<tr><td>permissions.organization_custom_roles</td><td>no</td><td>
177+
178+
The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.
179+
180180
</td></tr>
181181
<tr><td>permissions.organization_hooks</td><td>no</td><td>
182182

docs/codeScanning/deleteAnalysis.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ where a set is determined by a unique combination of analysis values:
3131

3232
- `ref`
3333
- `tool`
34-
- `analysis_key`
35-
- `environment`
34+
- `category`
3635

3736
If you attempt to delete an analysis that is not the most recent in a set,
3837
you'll get a 400 response with the message:

docs/codeScanning/listRecentAnalyses.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,16 @@ The Git reference for the analyses you want to list. The `ref` for a branch can
8383

8484
Filter analyses belonging to the same SARIF upload.
8585

86+
</td></tr>
87+
<tr><td>direction</td><td>no</td><td>
88+
89+
The direction to sort the results by.
90+
91+
</td></tr>
92+
<tr><td>sort</td><td>no</td><td>
93+
94+
The property by which to sort the results.
95+
8696
</td></tr>
8797
</tbody>
8898
</table>

docs/issues/update.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ Login for the user that this issue should be assigned to. **This field is deprec
6363

6464
State of the issue. Either `open` or `closed`.
6565

66+
</td></tr>
67+
<tr><td>state_reason</td><td>no</td><td>
68+
69+
The reason for the current state
70+
6671
</td></tr>
6772
<tr><td>milestone</td><td>no</td><td>
6873

docs/orgs/listCustomRoles.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ type: API method
1111
List the custom repository roles available in this organization. In order to see custom
1212
repository roles in an organization, the authenticated user must be an organization owner.
1313

14+
To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
15+
GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
16+
1417
For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".
1518

1619
```js

docs/repos/createFork.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ Optional parameter to specify the organization name if forking into an organizat
4949

5050
When forking from an existing repository, a new name for the fork.
5151

52+
</td></tr>
53+
<tr><td>default_branch_only</td><td>no</td><td>
54+
55+
When forking from an existing repository, fork with only the default branch.
56+
5257
</td></tr>
5358
</tbody>
5459
</table>

docs/repos/getContent.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ retrieving the raw content or rendered HTML (when supported). All content types
1616
type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
1717
object format.
1818

19-
**Note**:
19+
**Notes**:
2020

2121
- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).
2222
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
2323
API](https://docs.github.com/rest/reference/git#get-a-tree).
24+
- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
2425

2526
#### Size limits
2627

scripts/update-endpoints/generated/endpoints.json

Lines changed: 109 additions & 41 deletions
Large diffs are not rendered by default.

src/generated/method-types.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2855,8 +2855,7 @@ export type RestEndpointMethods = {
28552855
*
28562856
* * `ref`
28572857
* * `tool`
2858-
* * `analysis_key`
2859-
* * `environment`
2858+
* * `category`
28602859
*
28612860
* If you attempt to delete an analysis that is not the most recent in a set,
28622861
* you'll get a 400 response with the message:
@@ -6071,6 +6070,9 @@ export type RestEndpointMethods = {
60716070
* List the custom repository roles available in this organization. In order to see custom
60726071
* repository roles in an organization, the authenticated user must be an organization owner.
60736072
*
6073+
* To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
6074+
* GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
6075+
*
60746076
* For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".
60756077
*/
60766078
listCustomRoles: {
@@ -8958,11 +8960,11 @@ export type RestEndpointMethods = {
89588960
* type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
89598961
* object format.
89608962
*
8961-
* **Note**:
8963+
* **Notes**:
89628964
* * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).
89638965
* * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
89648966
* API](https://docs.github.com/rest/reference/git#get-a-tree).
8965-
*
8967+
* * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
89668968
* #### Size limits
89678969
* If the requested file's size is:
89688970
* * 1 MB or smaller: All features of this endpoint are supported.

0 commit comments

Comments
 (0)