Skip to content

Commit 9e3a47a

Browse files
gr2mgr2m
authored
feat: octokit.repos.getReadmeInDirectory(), octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (deprecates octokit.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser()), octokit.packages.getAllPackageVersionsForPackageOwnedByOrg() (deprecates `octokit.packages.getAllPackageVersionsForAPackageOwnedByAnOrg) (#364)
1 parent 4696e39 commit 9e3a47a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+2647
-1690
lines changed

‎docs/actions/listSelectedReposForOrgSecret.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ octokit.actions.listSelectedReposForOrgSecret({
3535

3636
secret_name parameter
3737

38+
</td></tr>
39+
<tr><td>page</td><td>no</td><td>
40+
41+
Page number of the results to fetch.
42+
43+
</td></tr>
44+
<tr><td>per_page</td><td>no</td><td>
45+
46+
Results per page (max 100).
47+
3848
</td></tr>
3949
</tbody>
4050
</table>

‎docs/billing/getGithubActionsBillingOrg.md

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

1111
Gets the summary of the free and paid GitHub Actions minutes used.
1212

13-
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)".
13+
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 returned includes any minute multipliers for macOS and Windows runners, and is 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

1515
Access tokens must have the `repo` or `admin:org` scope.
1616

‎docs/billing/getGithubActionsBillingUser.md

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

1111
Gets the summary of the free and paid GitHub Actions minutes used.
1212

13-
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)".
13+
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 returned includes any minute multipliers for macOS and Windows runners, and is 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

1515
Access tokens must have the `user` scope.
1616

‎docs/checks/listForRef.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ octokit.checks.listForRef({
3939
</td></tr>
4040
<tr><td>ref</td><td>yes</td><td>
4141

42-
ref+ parameter
42+
ref parameter
4343

4444
</td></tr>
4545
<tr><td>check_name</td><td>no</td><td>
@@ -66,6 +66,9 @@ Results per page (max 100).
6666

6767
Page number of the results to fetch.
6868

69+
</td></tr>
70+
<tr><td>app_id</td><td>no</td><td>
71+
6972
</td></tr>
7073
</tbody>
7174
</table>

‎docs/checks/listSuitesForRef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ octokit.checks.listSuitesForRef({
3939
</td></tr>
4040
<tr><td>ref</td><td>yes</td><td>
4141

42-
ref+ parameter
42+
ref parameter
4343

4444
</td></tr>
4545
<tr><td>app_id</td><td>no</td><td>

‎docs/codeScanning/deleteAnalysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-sca
107107
</td></tr>
108108
<tr><td>confirm_delete</td><td>no</td><td>
109109

110-
Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`
110+
Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`
111111

112112
</td></tr>
113113
</tbody>

‎docs/git/deleteRef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ octokit.git.deleteRef({
3535
</td></tr>
3636
<tr><td>ref</td><td>yes</td><td>
3737

38-
ref+ parameter
38+
ref parameter
3939

4040
</td></tr>
4141
</tbody>

‎docs/git/getRef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ octokit.git.getRef({
3939
</td></tr>
4040
<tr><td>ref</td><td>yes</td><td>
4141

42-
ref+ parameter
42+
ref parameter
4343

4444
</td></tr>
4545
</tbody>

‎docs/git/listMatchingRefs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ octokit.git.listMatchingRefs({
4343
</td></tr>
4444
<tr><td>ref</td><td>yes</td><td>
4545

46-
ref+ parameter
46+
ref parameter
4747

4848
</td></tr>
4949
<tr><td>per_page</td><td>no</td><td>

‎docs/git/updateRef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ octokit.git.updateRef({
3636
</td></tr>
3737
<tr><td>ref</td><td>yes</td><td>
3838

39-
ref+ parameter
39+
ref parameter
4040

4141
</td></tr>
4242
<tr><td>sha</td><td>yes</td><td>

‎docs/interactions/getRestrictionsForAuthenticatedUser.md

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

99
# Get interaction restrictions for your public repositories
1010

11-
Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response.
11+
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
1212

1313
```js
1414
octokit.interactions.getRestrictionsForAuthenticatedUser();

‎docs/interactions/getRestrictionsForYourPublicRepos.md

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

1111
**Deprecated:** This method has been renamed to interactions.getRestrictionsForAuthenticatedUser
1212

13-
Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response.
13+
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
1414

1515
```js
1616
octokit.interactions.getRestrictionsForYourPublicRepos();

‎docs/issues/createLabel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ octokit.issues.createLabel({
3535
</td></tr>
3636
<tr><td>name</td><td>yes</td><td>
3737

38-
The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).
38+
The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)."
3939

4040
</td></tr>
4141
<tr><td>color</td><td>no</td><td>

‎docs/issues/updateLabel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ octokit.issues.updateLabel({
3838
</td></tr>
3939
<tr><td>new_name</td><td>no</td><td>
4040

41-
The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).
41+
The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)."
4242

4343
</td></tr>
4444
<tr><td>color</td><td>no</td><td>

‎docs/licenses/getAllCommonlyUsed.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ octokit.licenses.getAllCommonlyUsed();
3030

3131
Results per page (max 100).
3232

33+
</td></tr>
34+
<tr><td>page</td><td>no</td><td>
35+
36+
Page number of the results to fetch.
37+
3338
</td></tr>
3439
</tbody>
3540
</table>

‎docs/migrations/getStatusForOrg.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ octokit.migrations.getStatusForOrg({
4242

4343
migration_id parameter
4444

45+
</td></tr>
46+
<tr><td>exclude</td><td>no</td><td>
47+
48+
Exclude attributes from the API response to improve performance
49+
4550
</td></tr>
4651
</tbody>
4752
</table>

‎docs/migrations/listForOrg.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ Results per page (max 100).
3939

4040
Page number of the results to fetch.
4141

42+
</td></tr>
43+
<tr><td>exclude</td><td>no</td><td>
44+
45+
Exclude attributes from the API response to improve performance
46+
4247
</td></tr>
4348
</tbody>
4449
</table>

‎docs/orgs/getMembershipForUser.md

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

99
# Get organization membership for a user
1010

11-
In order to get a user's membership with an organization, the authenticated user must be an organization member.
11+
In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.
1212

1313
```js
1414
octokit.orgs.getMembershipForUser({

‎docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md

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

99
# Get all package versions for a package owned by an organization
1010

11+
**Deprecated:** This method has been renamed to packages.getAllPackageVersionsForPackageOwnedByOrg
12+
1113
Returns all package versions for a package owned by an organization.
1214

1315
To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
@@ -44,6 +46,21 @@ The name of the package.
4446
</td></tr>
4547
<tr><td>org</td><td>yes</td><td>
4648

49+
</td></tr>
50+
<tr><td>page</td><td>no</td><td>
51+
52+
Page number of the results to fetch.
53+
54+
</td></tr>
55+
<tr><td>per_page</td><td>no</td><td>
56+
57+
Results per page (max 100).
58+
59+
</td></tr>
60+
<tr><td>state</td><td>no</td><td>
61+
62+
The state of the package, either active or deleted.
63+
4764
</td></tr>
4865
</tbody>
4966
</table>

‎docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md

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

99
# Get all package versions for a package owned by the authenticated user
1010

11+
**Deprecated:** This method has been renamed to packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser
12+
1113
Returns all package versions for a package owned by the authenticated user.
1214

1315
To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
@@ -40,6 +42,21 @@ The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`
4042

4143
The name of the package.
4244

45+
</td></tr>
46+
<tr><td>page</td><td>no</td><td>
47+
48+
Page number of the results to fetch.
49+
50+
</td></tr>
51+
<tr><td>per_page</td><td>no</td><td>
52+
53+
Results per page (max 100).
54+
55+
</td></tr>
56+
<tr><td>state</td><td>no</td><td>
57+
58+
The state of the package, either active or deleted.
59+
4360
</td></tr>
4461
</tbody>
4562
</table>

‎docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Get all package versions for a package owned by the authenticated user
3+
example: octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser({ package_type, package_name })
4+
route: GET /user/packages/{package_type}/{package_name}/versions
5+
scope: packages
6+
type: API method
7+
---
8+
9+
# Get all package versions for a package owned by the authenticated user
10+
11+
Returns all package versions for a package owned by the authenticated user.
12+
13+
To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
14+
If `package_type` is not `container`, your token must also include the `repo` scope.
15+
16+
```js
17+
octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser({
18+
package_type,
19+
package_name,
20+
});
21+
```
22+
23+
## Parameters
24+
25+
<table>
26+
<thead>
27+
<tr>
28+
<th>name</th>
29+
<th>required</th>
30+
<th>description</th>
31+
</tr>
32+
</thead>
33+
<tbody>
34+
<tr><td>package_type</td><td>yes</td><td>
35+
36+
The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`.
37+
38+
</td></tr>
39+
<tr><td>package_name</td><td>yes</td><td>
40+
41+
The name of the package.
42+
43+
</td></tr>
44+
<tr><td>page</td><td>no</td><td>
45+
46+
Page number of the results to fetch.
47+
48+
</td></tr>
49+
<tr><td>per_page</td><td>no</td><td>
50+
51+
Results per page (max 100).
52+
53+
</td></tr>
54+
<tr><td>state</td><td>no</td><td>
55+
56+
The state of the package, either active or deleted.
57+
58+
</td></tr>
59+
</tbody>
60+
</table>
61+
62+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user).

‎docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: Get all package versions for a package owned by an organization
3+
example: octokit.packages.getAllPackageVersionsForPackageOwnedByOrg({ package_type, package_name, org })
4+
route: GET /orgs/{org}/packages/{package_type}/{package_name}/versions
5+
scope: packages
6+
type: API method
7+
---
8+
9+
# Get all package versions for a package owned by an organization
10+
11+
Returns all package versions for a package owned by an organization.
12+
13+
To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
14+
If `package_type` is not `container`, your token must also include the `repo` scope.
15+
16+
```js
17+
octokit.packages.getAllPackageVersionsForPackageOwnedByOrg({
18+
package_type,
19+
package_name,
20+
org,
21+
});
22+
```
23+
24+
## Parameters
25+
26+
<table>
27+
<thead>
28+
<tr>
29+
<th>name</th>
30+
<th>required</th>
31+
<th>description</th>
32+
</tr>
33+
</thead>
34+
<tbody>
35+
<tr><td>package_type</td><td>yes</td><td>
36+
37+
The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`.
38+
39+
</td></tr>
40+
<tr><td>package_name</td><td>yes</td><td>
41+
42+
The name of the package.
43+
44+
</td></tr>
45+
<tr><td>org</td><td>yes</td><td>
46+
47+
</td></tr>
48+
<tr><td>page</td><td>no</td><td>
49+
50+
Page number of the results to fetch.
51+
52+
</td></tr>
53+
<tr><td>per_page</td><td>no</td><td>
54+
55+
Results per page (max 100).
56+
57+
</td></tr>
58+
<tr><td>state</td><td>no</td><td>
59+
60+
The state of the package, either active or deleted.
61+
62+
</td></tr>
63+
</tbody>
64+
</table>
65+
66+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user).

0 commit comments

Comments
 (0)