Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/actions/listSelectedReposForOrgSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ octokit.actions.listSelectedReposForOrgSecret({

secret_name parameter

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

Results per page (max 100).

</td></tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/billing/getGithubActionsBillingOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

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

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)".
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)".

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

Expand Down
2 changes: 1 addition & 1 deletion docs/billing/getGithubActionsBillingUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

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

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)".
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)".

Access tokens must have the `user` scope.

Expand Down
5 changes: 4 additions & 1 deletion docs/checks/listForRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ octokit.checks.listForRef({
</td></tr>
<tr><td>ref</td><td>yes</td><td>

ref+ parameter
ref parameter

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

Page number of the results to fetch.

</td></tr>
<tr><td>app_id</td><td>no</td><td>

</td></tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/checks/listSuitesForRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ octokit.checks.listSuitesForRef({
</td></tr>
<tr><td>ref</td><td>yes</td><td>

ref+ parameter
ref parameter

</td></tr>
<tr><td>app_id</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/codeScanning/deleteAnalysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-sca
</td></tr>
<tr><td>confirm_delete</td><td>no</td><td>

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.`
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.`

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/git/deleteRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ octokit.git.deleteRef({
</td></tr>
<tr><td>ref</td><td>yes</td><td>

ref+ parameter
ref parameter

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/git/getRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ octokit.git.getRef({
</td></tr>
<tr><td>ref</td><td>yes</td><td>

ref+ parameter
ref parameter

</td></tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/git/listMatchingRefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ octokit.git.listMatchingRefs({
</td></tr>
<tr><td>ref</td><td>yes</td><td>

ref+ parameter
ref parameter

</td></tr>
<tr><td>per_page</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/git/updateRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ octokit.git.updateRef({
</td></tr>
<tr><td>ref</td><td>yes</td><td>

ref+ parameter
ref parameter

</td></tr>
<tr><td>sha</td><td>yes</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/interactions/getRestrictionsForAuthenticatedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: API method

# Get interaction restrictions for your public repositories

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.
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

```js
octokit.interactions.getRestrictionsForAuthenticatedUser();
Expand Down
2 changes: 1 addition & 1 deletion docs/interactions/getRestrictionsForYourPublicRepos.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

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

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.
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

```js
octokit.interactions.getRestrictionsForYourPublicRepos();
Expand Down
2 changes: 1 addition & 1 deletion docs/issues/createLabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ octokit.issues.createLabel({
</td></tr>
<tr><td>name</td><td>yes</td><td>

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/).
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)."

</td></tr>
<tr><td>color</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/issues/updateLabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ octokit.issues.updateLabel({
</td></tr>
<tr><td>new_name</td><td>no</td><td>

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/).
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)."

</td></tr>
<tr><td>color</td><td>no</td><td>
Expand Down
5 changes: 5 additions & 0 deletions docs/licenses/getAllCommonlyUsed.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ octokit.licenses.getAllCommonlyUsed();

Results per page (max 100).

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/migrations/getStatusForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ octokit.migrations.getStatusForOrg({

migration_id parameter

</td></tr>
<tr><td>exclude</td><td>no</td><td>

Exclude attributes from the API response to improve performance

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/migrations/listForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Results per page (max 100).

Page number of the results to fetch.

</td></tr>
<tr><td>exclude</td><td>no</td><td>

Exclude attributes from the API response to improve performance

</td></tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/orgs/getMembershipForUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: API method

# Get organization membership for a user

In order to get a user's membership with an organization, the authenticated user must be an organization member.
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.

```js
octokit.orgs.getMembershipForUser({
Expand Down
17 changes: 17 additions & 0 deletions docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ type: API method

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

**Deprecated:** This method has been renamed to packages.getAllPackageVersionsForPackageOwnedByOrg

Returns all package versions for a package owned by an organization.

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

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

Results per page (max 100).

</td></tr>
<tr><td>state</td><td>no</td><td>

The state of the package, either active or deleted.

</td></tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ type: API method

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

**Deprecated:** This method has been renamed to packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser

Returns all package versions for a package owned by the authenticated user.

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

The name of the package.

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

Results per page (max 100).

</td></tr>
<tr><td>state</td><td>no</td><td>

The state of the package, either active or deleted.

</td></tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: Get all package versions for a package owned by the authenticated user
example: octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser({ package_type, package_name })
route: GET /user/packages/{package_type}/{package_name}/versions
scope: packages
type: API method
---

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

Returns all package versions for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
If `package_type` is not `container`, your token must also include the `repo` scope.

```js
octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser({
package_type,
package_name,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>package_type</td><td>yes</td><td>

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`.

</td></tr>
<tr><td>package_name</td><td>yes</td><td>

The name of the package.

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

Results per page (max 100).

</td></tr>
<tr><td>state</td><td>no</td><td>

The state of the package, either active or deleted.

</td></tr>
</tbody>
</table>

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).
66 changes: 66 additions & 0 deletions docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
name: Get all package versions for a package owned by an organization
example: octokit.packages.getAllPackageVersionsForPackageOwnedByOrg({ package_type, package_name, org })
route: GET /orgs/{org}/packages/{package_type}/{package_name}/versions
scope: packages
type: API method
---

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

Returns all package versions for a package owned by an organization.

To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
If `package_type` is not `container`, your token must also include the `repo` scope.

```js
octokit.packages.getAllPackageVersionsForPackageOwnedByOrg({
package_type,
package_name,
org,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>package_type</td><td>yes</td><td>

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`.

</td></tr>
<tr><td>package_name</td><td>yes</td><td>

The name of the package.

</td></tr>
<tr><td>org</td><td>yes</td><td>

</td></tr>
<tr><td>page</td><td>no</td><td>

Page number of the results to fetch.

</td></tr>
<tr><td>per_page</td><td>no</td><td>

Results per page (max 100).

</td></tr>
<tr><td>state</td><td>no</td><td>

The state of the package, either active or deleted.

</td></tr>
</tbody>
</table>

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).
Loading