diff --git a/docs/issues/setLabels.md b/docs/issues/setLabels.md index 1b6ce00a3..ef6ff2759 100644 --- a/docs/issues/setLabels.md +++ b/docs/issues/setLabels.md @@ -1,6 +1,6 @@ --- name: Set labels for an issue -example: octokit.rest.issues.setLabels({ owner, repo, issue_number }) +example: octokit.rest.issues.setLabels({ owner, repo, issue_number, labels[].name }) route: PUT /repos/{owner}/{repo}/issues/{issue_number}/labels scope: issues type: API method @@ -12,10 +12,11 @@ Removes any previous labels and sets the new labels for an issue. ```js octokit.rest.issues.setLabels({ - owner, - repo, - issue_number, -}); + owner, +repo, +issue_number, +labels[].name + }) ``` ## Parameters @@ -39,6 +40,12 @@ octokit.rest.issues.setLabels({ issue_number parameter + +labelsno + + +labels[].nameyes + diff --git a/docs/packages/deletePackageForUser.md b/docs/packages/deletePackageForUser.md new file mode 100644 index 000000000..344bc4822 --- /dev/null +++ b/docs/packages/deletePackageForUser.md @@ -0,0 +1,53 @@ +--- +name: Delete a package for a user +example: octokit.rest.packages.deletePackageForUser({ package_type, package_name, username }) +route: DELETE /users/{username}/packages/{package_type}/{package_name} +scope: packages +type: API method +--- + +# Delete a package for a user + +Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. + +To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: + +- If `package_type` is not `container`, your token must also include the `repo` scope. +- If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + +```js +octokit.rest.packages.deletePackageForUser({ + package_type, + package_name, + username, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
package_nameyes + +The name of the package. + +
usernameyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user). diff --git a/docs/packages/deletePackageVersionForUser.md b/docs/packages/deletePackageVersionForUser.md new file mode 100644 index 000000000..7182e43a2 --- /dev/null +++ b/docs/packages/deletePackageVersionForUser.md @@ -0,0 +1,59 @@ +--- +name: Delete package version for a user +example: octokit.rest.packages.deletePackageVersionForUser({ package_type, package_name, username, package_version_id }) +route: DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id} +scope: packages +type: API method +--- + +# Delete package version for a user + +Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. + +To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: + +- If `package_type` is not `container`, your token must also include the `repo` scope. +- If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + +```js +octokit.rest.packages.deletePackageVersionForUser({ + package_type, + package_name, + username, + package_version_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
package_nameyes + +The name of the package. + +
usernameyes + +
package_version_idyes + +Unique identifier of the package version. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user). diff --git a/docs/packages/listPackagesForAuthenticatedUser.md b/docs/packages/listPackagesForAuthenticatedUser.md new file mode 100644 index 000000000..5bba0dcbb --- /dev/null +++ b/docs/packages/listPackagesForAuthenticatedUser.md @@ -0,0 +1,46 @@ +--- +name: List packages for the authenticated user's namespace +example: octokit.rest.packages.listPackagesForAuthenticatedUser({ package_type }) +route: GET /user/packages +scope: packages +type: API method +--- + +# List packages for the authenticated user's namespace + +Lists packages owned by the authenticated user within the user's namespace. + +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.rest.packages.listPackagesForAuthenticatedUser({ + package_type, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
visibilityno + +The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user). diff --git a/docs/packages/listPackagesForOrganization.md b/docs/packages/listPackagesForOrganization.md new file mode 100644 index 000000000..375fddc54 --- /dev/null +++ b/docs/packages/listPackagesForOrganization.md @@ -0,0 +1,50 @@ +--- +name: List packages for an organization +example: octokit.rest.packages.listPackagesForOrganization({ package_type, org }) +route: GET /orgs/{org}/packages +scope: packages +type: API method +--- + +# List packages for an organization + +Lists all packages in an organization readable by the 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.rest.packages.listPackagesForOrganization({ + package_type, + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
orgyes + +
visibilityno + +The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-packages-for-an-organization). diff --git a/docs/packages/listPackagesForUser.md b/docs/packages/listPackagesForUser.md new file mode 100644 index 000000000..bdd449165 --- /dev/null +++ b/docs/packages/listPackagesForUser.md @@ -0,0 +1,50 @@ +--- +name: List packages for a user +example: octokit.rest.packages.listPackagesForUser({ package_type, username }) +route: GET /user/{username}/packages +scope: packages +type: API method +--- + +# List packages for a user + +Lists all packages in a user's namespace for which the requesting user has access. + +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.rest.packages.listPackagesForUser({ + package_type, + username, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
visibilityno + +The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. + +
usernameyes + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-packages-for-user). diff --git a/docs/packages/restorePackageForUser.md b/docs/packages/restorePackageForUser.md new file mode 100644 index 000000000..3b5851ea7 --- /dev/null +++ b/docs/packages/restorePackageForUser.md @@ -0,0 +1,63 @@ +--- +name: Restore a package for a user +example: octokit.rest.packages.restorePackageForUser({ package_type, package_name, username }) +route: POST /users/{username}/packages/{package_type}/{package_name}/restore{?token} +scope: packages +type: API method +--- + +# Restore a package for a user + +Restores an entire package for a user. + +You can restore a deleted package under the following conditions: + +- The package was deleted within the last 30 days. +- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + +To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: + +- If `package_type` is not `container`, your token must also include the `repo` scope. +- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + +```js +octokit.rest.packages.restorePackageForUser({ + package_type, + package_name, + username, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
package_nameyes + +The name of the package. + +
usernameyes + +
tokenno + +package token + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user). diff --git a/docs/packages/restorePackageVersionForUser.md b/docs/packages/restorePackageVersionForUser.md new file mode 100644 index 000000000..824684fa4 --- /dev/null +++ b/docs/packages/restorePackageVersionForUser.md @@ -0,0 +1,64 @@ +--- +name: Restore package version for a user +example: octokit.rest.packages.restorePackageVersionForUser({ package_type, package_name, username, package_version_id }) +route: POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore +scope: packages +type: API method +--- + +# Restore package version for a user + +Restores a specific package version for a user. + +You can restore a deleted package under the following conditions: + +- The package was deleted within the last 30 days. +- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + +To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: + +- If `package_type` is not `container`, your token must also include the `repo` scope. +- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + +```js +octokit.rest.packages.restorePackageVersionForUser({ + package_type, + package_name, + username, + package_version_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + + +
namerequireddescription
package_typeyes + +The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + +
package_nameyes + +The name of the package. + +
usernameyes + +
package_version_idyes + +Unique identifier of the package version. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user). diff --git a/docs/secretScanning/listAlertsForOrg.md b/docs/secretScanning/listAlertsForOrg.md new file mode 100644 index 000000000..c82594933 --- /dev/null +++ b/docs/secretScanning/listAlertsForOrg.md @@ -0,0 +1,59 @@ +--- +name: Lists secret scanning alerts by organization +example: octokit.rest.secretScanning.listAlertsForOrg({ org }) +route: GET /orgs/{org}/secret-scanning/alerts +scope: secretScanning +type: API method +--- + +# Lists secret scanning alerts by organization + +Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest. +To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + +GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + +```js +octokit.rest.secretScanning.listAlertsForOrg({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +
stateno + +Set to `open` or `resolved` to only list secret scanning alerts in a specific state. + +
secret_typeno + +A comma separated list of secret types to return. By default all secret types are returned. + +
pageno + +Page number of the results to fetch. + +
per_pageno + +Results per page (max 100) + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization). diff --git a/package-lock.json b/package-lock.json index 1a616c829..be1a4e0c8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1135,12 +1135,12 @@ } }, "@graphql-tools/merge": { - "version": "8.0.3", - "resolved": "https://registry.npmjs.org/@graphql-tools/merge/-/merge-8.0.3.tgz", - "integrity": "sha512-lVMyW9cREs+nQYbUvMaaqSl+pRCezl2RafNMFi/04akjvOtjVefdi7n3pArpSqPhLHPJDyQRlI8CK8cmOZ9jTA==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@graphql-tools/merge/-/merge-8.1.0.tgz", + "integrity": "sha512-Lza419UHgnn0w42wLpviHYmg/k42bdxTsguAaUwfrgMbJ99nyx8/1Owu1ij6k1bc5RN0YynS5N/rLGw7skw8vQ==", "dev": true, "requires": { - "@graphql-tools/utils": "^8.1.2", + "@graphql-tools/utils": "^8.2.0", "tslib": "~2.3.0" }, "dependencies": { @@ -1153,13 +1153,13 @@ } }, "@graphql-tools/schema": { - "version": "8.1.2", - "resolved": "https://registry.npmjs.org/@graphql-tools/schema/-/schema-8.1.2.tgz", - "integrity": "sha512-rX2pg42a0w7JLVYT+f/yeEKpnoZL5PpLq68TxC3iZ8slnNBNjfVfvzzOn8Q8Q6Xw3t17KP9QespmJEDfuQe4Rg==", + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/@graphql-tools/schema/-/schema-8.2.0.tgz", + "integrity": "sha512-ufmI5mJQa8NJczzfkh0pUttKvspqDcT5LLakA3jUmOrrE4d4NVj6onZlazdTzF5sAepSNqanFnwhrxZpCAJMKg==", "dev": true, "requires": { - "@graphql-tools/merge": "^8.0.2", - "@graphql-tools/utils": "^8.1.1", + "@graphql-tools/merge": "^8.1.0", + "@graphql-tools/utils": "^8.2.0", "tslib": "~2.3.0", "value-or-promise": "1.0.10" }, @@ -1173,9 +1173,9 @@ } }, "@graphql-tools/utils": { - "version": "8.1.2", - "resolved": "https://registry.npmjs.org/@graphql-tools/utils/-/utils-8.1.2.tgz", - "integrity": "sha512-3G+NIBR5mHjPm78jAD0l07JRE0XH+lr9m7yL/wl69jAzK0Jr/H+/Ok4ljEolI70iglz+ZhIShVPAwyesF6rnFg==", + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@graphql-tools/utils/-/utils-8.2.1.tgz", + "integrity": "sha512-xjyetFpDy2/MY8P4+NiE7i1czCrAI36Twjm+jcoBfPctMnJegZkZnLfepmjwYQ92Sv9hnhr+x52OUQAddj29CQ==", "dev": true, "requires": { "tslib": "~2.3.0" @@ -1823,9 +1823,9 @@ } }, "@octokit/graphql": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.7.0.tgz", - "integrity": "sha512-diY0qMPyQjfu4rDu3kDhJ9qIZadIm4IISO3RJSv9ajYUWJUCO0AykbgzLcg1xclxtXgzY583u3gAv66M6zz5SA==", + "version": "4.8.0", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.8.0.tgz", + "integrity": "sha512-0gv+qLSBLKF0z8TKaSKTsS39scVKF9dbMxJpj3U0vC7wjNWFuIpL/z76Qe2fiuCbDRcJSavkXsVtMS6/dtQQsg==", "dev": true, "requires": { "@octokit/request": "^5.6.0", @@ -1834,9 +1834,9 @@ } }, "@octokit/openapi-types": { - "version": "9.7.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-9.7.0.tgz", - "integrity": "sha512-TUJ16DJU8mekne6+KVcMV5g6g/rJlrnIKn7aALG9QrNpnEipFc1xjoarh0PKaAWf2Hf+HwthRKYt+9mCm5RsRg==" + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.0.0.tgz", + "integrity": "sha512-k1iO2zKuEjjRS1EJb4FwSLk+iF6EGp+ZV0OMRViQoWhQ1fZTk9hg1xccZII5uyYoiqcbC73MRBmT45y1vp2PPg==" }, "@octokit/plugin-paginate-rest": { "version": "2.15.1", @@ -1901,11 +1901,11 @@ } }, "@octokit/types": { - "version": "6.25.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.25.0.tgz", - "integrity": "sha512-bNvyQKfngvAd/08COlYIN54nRgxskmejgywodizQNyiKoXmWRAjKup2/LYwm+T9V0gsKH6tuld1gM0PzmOiB4Q==", + "version": "6.26.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.26.0.tgz", + "integrity": "sha512-RDxZBAFMtqs1ZPnbUu1e7ohPNfoNhTiep4fErY7tZs995BeHu369Vsh5woMIaFbllRWEZBfvTCS4hvDnMPiHrA==", "requires": { - "@octokit/openapi-types": "^9.5.0" + "@octokit/openapi-types": "^10.0.0" } }, "@pika/babel-plugin-esm-import-rewrite": { @@ -2429,9 +2429,9 @@ "dev": true }, "@types/node": { - "version": "14.17.12", - "resolved": "https://registry.npmjs.org/@types/node/-/node-14.17.12.tgz", - "integrity": "sha512-vhUqgjJR1qxwTWV5Ps5txuy2XMdf7Fw+OrdChRboy8BmWUPkckOhphaohzFG6b8DW7CrxaBMdrdJ47SYFq1okw==", + "version": "14.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.17.13.tgz", + "integrity": "sha512-OqG3iSnFg3cnJLsSRyhriILdDfBOwGty0fmnalbsPdYKbDgK6TI9On/36lzO/1bcaeEkg9OGD2wYLjx8t5MZNQ==", "dev": true }, "@types/normalize-package-data": { @@ -3742,9 +3742,9 @@ } }, "core-util-is": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", - "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", "dev": true }, "cosmiconfig": { @@ -4075,9 +4075,9 @@ "dev": true }, "electron-to-chromium": { - "version": "1.3.822", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.822.tgz", - "integrity": "sha512-k7jG5oYYHxF4jx6PcqwHX3JVME/OjzolqOZiIogi9xtsfsmTjTdie4x88OakYFPEa8euciTgCCzvVNwvmjHb1Q==", + "version": "1.3.824", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.824.tgz", + "integrity": "sha512-Fk+5aD0HDi9i9ZKt9n2VPOZO1dQy7PV++hz2wJ/KIn+CvVfu4fny39squHtyVDPuHNuoJGAZIbuReEklqYIqfA==", "dev": true }, "elegant-spinner": { @@ -4825,9 +4825,9 @@ "dev": true }, "graphql": { - "version": "15.5.1", - "resolved": "https://registry.npmjs.org/graphql/-/graphql-15.5.1.tgz", - "integrity": "sha512-FeTRX67T3LoE3LWAxxOlW2K3Bz+rMYAC18rRguK4wgXaTZMiJwSUwDmPFo3UadAKbzirKIg5Qy+sNJXbpPRnQw==", + "version": "15.5.2", + "resolved": "https://registry.npmjs.org/graphql/-/graphql-15.5.2.tgz", + "integrity": "sha512-dZjLPWNQqYv0dqV2RNbiFed0LtSp6yd4jchsDGnuhDKa9OQHJYCfovaOEvY91w9gqbYO7Se9LKDTl3xxYva/3w==", "dev": true }, "handlebars": { @@ -8254,74 +8254,74 @@ "integrity": "sha512-k7XQNHGHAp0VowMMUMRMtntxWatNad9hhYrelUKDPvZ++DBxvofA8QTNPiuMKtx8CBOFA8iJ4aizhbx6ZYVfzQ==", "dev": true, "requires": { - "@npmcli/arborist": "*", - "@npmcli/ci-detect": "*", - "@npmcli/config": "*", - "@npmcli/map-workspaces": "*", - "@npmcli/package-json": "*", - "@npmcli/run-script": "*", - "abbrev": "*", - "ansicolors": "*", - "ansistyles": "*", - "archy": "*", - "cacache": "*", - "chalk": "*", - "chownr": "*", - "cli-columns": "*", - "cli-table3": "*", - "columnify": "*", - "fastest-levenshtein": "*", - "glob": "*", - "graceful-fs": "*", - "hosted-git-info": "*", - "ini": "*", - "init-package-json": "*", - "is-cidr": "*", - "json-parse-even-better-errors": "*", - "libnpmaccess": "*", - "libnpmdiff": "*", - "libnpmexec": "*", - "libnpmfund": "*", - "libnpmhook": "*", - "libnpmorg": "*", - "libnpmpack": "*", - "libnpmpublish": "*", - "libnpmsearch": "*", - "libnpmteam": "*", - "libnpmversion": "*", - "make-fetch-happen": "*", - "minipass": "*", - "minipass-pipeline": "*", - "mkdirp": "*", - "mkdirp-infer-owner": "*", - "ms": "*", - "node-gyp": "*", - "nopt": "*", - "npm-audit-report": "*", - "npm-package-arg": "*", - "npm-pick-manifest": "*", - "npm-profile": "*", - "npm-registry-fetch": "*", - "npm-user-validate": "*", - "npmlog": "*", - "opener": "*", - "pacote": "*", - "parse-conflict-json": "*", - "qrcode-terminal": "*", - "read": "*", - "read-package-json": "*", - "read-package-json-fast": "*", - "readdir-scoped-modules": "*", - "rimraf": "*", - "semver": "*", - "ssri": "*", - "tar": "*", - "text-table": "*", - "tiny-relative-date": "*", - "treeverse": "*", - "validate-npm-package-name": "*", - "which": "*", - "write-file-atomic": "*" + "@npmcli/arborist": "^2.8.2", + "@npmcli/ci-detect": "^1.2.0", + "@npmcli/config": "^2.2.0", + "@npmcli/map-workspaces": "^1.0.4", + "@npmcli/package-json": "^1.0.1", + "@npmcli/run-script": "^1.8.6", + "abbrev": "~1.1.1", + "ansicolors": "~0.3.2", + "ansistyles": "~0.1.3", + "archy": "~1.0.0", + "cacache": "^15.3.0", + "chalk": "^4.1.2", + "chownr": "^2.0.0", + "cli-columns": "^3.1.2", + "cli-table3": "^0.6.0", + "columnify": "~1.5.4", + "fastest-levenshtein": "^1.0.12", + "glob": "^7.1.7", + "graceful-fs": "^4.2.8", + "hosted-git-info": "^4.0.2", + "ini": "^2.0.0", + "init-package-json": "^2.0.4", + "is-cidr": "^4.0.2", + "json-parse-even-better-errors": "^2.3.1", + "libnpmaccess": "^4.0.2", + "libnpmdiff": "^2.0.4", + "libnpmexec": "^2.0.1", + "libnpmfund": "^1.1.0", + "libnpmhook": "^6.0.2", + "libnpmorg": "^2.0.2", + "libnpmpack": "^2.0.1", + "libnpmpublish": "^4.0.1", + "libnpmsearch": "^3.1.1", + "libnpmteam": "^2.0.3", + "libnpmversion": "^1.2.1", + "make-fetch-happen": "^9.1.0", + "minipass": "^3.1.3", + "minipass-pipeline": "^1.2.4", + "mkdirp": "^1.0.4", + "mkdirp-infer-owner": "^2.0.0", + "ms": "^2.1.2", + "node-gyp": "^7.1.2", + "nopt": "^5.0.0", + "npm-audit-report": "^2.1.5", + "npm-package-arg": "^8.1.5", + "npm-pick-manifest": "^6.1.1", + "npm-profile": "^5.0.3", + "npm-registry-fetch": "^11.0.0", + "npm-user-validate": "^1.0.1", + "npmlog": "^5.0.0", + "opener": "^1.5.2", + "pacote": "^11.3.5", + "parse-conflict-json": "^1.1.1", + "qrcode-terminal": "^0.12.0", + "read": "~1.0.7", + "read-package-json": "^4.0.1", + "read-package-json-fast": "^2.0.3", + "readdir-scoped-modules": "^1.1.0", + "rimraf": "^3.0.2", + "semver": "^7.3.5", + "ssri": "^8.0.1", + "tar": "^6.1.11", + "text-table": "~0.2.0", + "tiny-relative-date": "^1.3.0", + "treeverse": "^1.0.4", + "validate-npm-package-name": "~3.0.0", + "which": "^2.0.2", + "write-file-atomic": "^3.0.3" }, "dependencies": { "@gar/promisify": { @@ -11220,9 +11220,9 @@ } }, "resolve-alpn": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.0.tgz", - "integrity": "sha512-e4FNQs+9cINYMO5NMFc6kOUCdohjqFPSgMuwuZAOUWqrfWsen+Yjy5qZFkV5K7VO7tFSLKcUL97olkED7sCBHA==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", + "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", "dev": true }, "resolve-cwd": { diff --git a/package.json b/package.json index df15a7822..96c86dabe 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^6.25.0", + "@octokit/types": "^6.26.0", "deprecation": "^2.3.1" }, "devDependencies": { diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 8b009a241..ef680a2d6 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -6698,60 +6698,6 @@ ], "renamed": null }, - { - "name": "Check an authorization", - "scope": "apps", - "id": "checkAuthorization", - "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#check-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, { "name": "Check a token", "scope": "apps", @@ -8052,7 +7998,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" + "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" } ] }, @@ -8902,59 +8848,6 @@ ], "renamed": null }, - { - "name": "Reset an authorization", - "scope": "apps", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#reset-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, { "name": "Reset a token", "scope": "apps", @@ -9009,92 +8902,6 @@ ], "renamed": null }, - { - "name": "Revoke an authorization for an application", - "scope": "apps", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#revoke-an-authorization-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Revoke a grant for an application", - "scope": "apps", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/rest/reference/apps#revoke-a-grant-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, { "name": "Revoke an installation access token", "scope": "apps", @@ -19316,6 +19123,32 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "labels", + "description": "", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "labels[].name", + "description": "", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -23418,7 +23251,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" + "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" } ] }, @@ -25580,6 +25413,435 @@ ], "renamed": null }, + { + "name": "Delete a package for a user", + "scope": "packages", + "id": "deletePackageForUser", + "method": "DELETE", + "url": "/users/{username}/packages/{package_type}/{package_name}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Delete a package version for the authenticated user", + "scope": "packages", + "id": "deletePackageForUser", + "method": "DELETE", + "url": "/users/{username}/packages/{package_type}/{package_name}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Delete package version for a user", + "scope": "packages", + "id": "deletePackageVersionForUser", + "method": "DELETE", + "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get all package versions for a package owned by an organization", + "scope": "packages", + "id": "deletePackageVersionForAuthenticatedUser", + "method": "DELETE", + "url": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Delete package version for an organization", + "scope": "packages", + "id": "deletePackageVersionForOrg", + "method": "DELETE", + "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Delete package version for a user", + "scope": "packages", + "id": "deletePackageVersionForUser", + "method": "DELETE", + "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Delete a package version for the authenticated user", "scope": "packages", @@ -25723,6 +25985,84 @@ ], "renamed": null }, + { + "name": "Delete package version for a user", + "scope": "packages", + "id": "deletePackageVersionForUser", + "method": "DELETE", + "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, { "name": "Get all package versions for a package owned by an organization", "scope": "packages", @@ -26642,10 +26982,1521 @@ "description": "Response", "examples": [ { - "data": "{\"id\":387039,\"name\":\"0.2.0\",\"url\":\"https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039\",\"package_html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201\",\"license\":\"MIT\",\"created_at\":\"2019-12-01T20:49:29Z\",\"updated_at\":\"2019-12-01T20:49:30Z\",\"description\":\"Octo-name client for Ruby\",\"html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0\",\"metadata\":{\"package_type\":\"rubygems\"}}" + "data": "{\"id\":387039,\"name\":\"0.2.0\",\"url\":\"https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039\",\"package_html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201\",\"license\":\"MIT\",\"created_at\":\"2019-12-01T20:49:29Z\",\"updated_at\":\"2019-12-01T20:49:30Z\",\"description\":\"Octo-name client for Ruby\",\"html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0\",\"metadata\":{\"package_type\":\"rubygems\"}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List packages for the authenticated user's namespace", + "scope": "packages", + "id": "listPackagesForAuthenticatedUser", + "method": "GET", + "url": "/user/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List packages for an organization", + "scope": "packages", + "id": "listPackagesForOrganization", + "method": "GET", + "url": "/orgs/{org}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for a user", + "scope": "packages", + "id": "listPackagesForUser", + "method": "GET", + "url": "/user/{username}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore a package for the authenticated user", + "scope": "packages", + "id": "restorePackageForAuthenticatedUser", + "method": "POST", + "url": "/user/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "token", + "description": "package token", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore a package for an organization", + "scope": "packages", + "id": "restorePackageForOrg", + "method": "POST", + "url": "/orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "token", + "description": "package token", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Restore a package for a user", + "scope": "packages", + "id": "restorePackageForUser", + "method": "POST", + "url": "/users/{username}/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a package for a user", + "scope": "packages", + "id": "getPackageForUser", + "method": "GET", + "url": "/users/{username}/packages/{package_type}/{package_name}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Gets a specific package metadata for a public package owned by a user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":40201,\"name\":\"octo-name\",\"package_type\":\"rubygems\",\"owner\":{\"login\":\"octocat\",\"id\":209477,\"node_id\":\"MDQ6VXNlcjIwOTQ3Nw==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/209477?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"version_count\":3,\"visibility\":\"public\",\"url\":\"https://api.github.com/users/octocat/packages/rubygems/octo-name\",\"created_at\":\"2019-10-20T14:17:14Z\",\"updated_at\":\"2019-10-20T14:17:14Z\",\"repository\":{\"id\":216219492,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=\",\"name\":\"octo-name-repo\",\"full_name\":\"octocat/octo-name-repo\",\"private\":false,\"owner\":{\"login\":\"octocat\",\"id\":209477,\"node_id\":\"MDQ6VXNlcjIwOTQ3Nw==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/209477?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"html_url\":\"https://github.com/octocat/octo-name-repo\",\"description\":\"Project for octocats\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/octo-name-repo\",\"forks_url\":\"https://api.github.com/repos/octocat/octo-name-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/octo-name-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/octo-name-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/octo-name-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/octo-name-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/octo-name-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/octo-name-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/octo-name-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/octo-name-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/octo-name-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/octo-name-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/octo-name-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/octo-name-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/octo-name-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/octo-name-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/octo-name-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/octo-name-repo/deployments\"},\"html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a package version for the authenticated user", + "scope": "packages", + "id": "getPackageVersionForAuthenticatedUser", + "method": "GET", + "url": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":214,\"name\":\"sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a\",\"url\":\"https://api.github.com/users/octocat/packages/container/hello_docker/versions/214\",\"package_html_url\":\"https://github.com/users/octocat/packages/container/package/hello_docker\",\"created_at\":\"2020-05-15T03:46:45Z\",\"updated_at\":\"2020-05-15T03:46:45Z\",\"html_url\":\"https://github.com/users/octocat/packages/container/hello_docker/214\",\"metadata\":{\"package_type\":\"container\",\"container\":{\"tags\":[\"1.13.6\"]}}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a package version for an organization", + "scope": "packages", + "id": "getPackageVersionForOrganization", + "method": "GET", + "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Gets a specific package version in an organization.\n\nYou must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":836,\"name\":\"sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker/versions/836\",\"package_html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/hello_docker/836\",\"metadata\":{\"package_type\":\"container\",\"container\":{\"tags\":[\"latest\"]}}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a package version for a user", + "scope": "packages", + "id": "getPackageVersionForUser", + "method": "GET", + "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Gets a specific package version for a public package owned by a specified user.\n\nAt this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":387039,\"name\":\"0.2.0\",\"url\":\"https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039\",\"package_html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201\",\"license\":\"MIT\",\"created_at\":\"2019-12-01T20:49:29Z\",\"updated_at\":\"2019-12-01T20:49:30Z\",\"description\":\"Octo-name client for Ruby\",\"html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0\",\"metadata\":{\"package_type\":\"rubygems\"}}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for the authenticated user's namespace", + "scope": "packages", + "id": "listPackagesForAuthenticatedUser", + "method": "GET", + "url": "/user/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for an organization", + "scope": "packages", + "id": "listPackagesForOrganization", + "method": "GET", + "url": "/orgs/{org}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for a user", + "scope": "packages", + "id": "listPackagesForUser", + "method": "GET", + "url": "/user/{username}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for the authenticated user's namespace", + "scope": "packages", + "id": "listPackagesForAuthenticatedUser", + "method": "GET", + "url": "/user/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List packages for an organization", + "scope": "packages", + "id": "listPackagesForOrganization", + "method": "GET", + "url": "/orgs/{org}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for a user", + "scope": "packages", + "id": "listPackagesForUser", + "method": "GET", + "url": "/user/{username}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore a package for the authenticated user", + "scope": "packages", + "id": "restorePackageForAuthenticatedUser", + "method": "POST", + "url": "/user/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "token", + "description": "package token", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore a package for an organization", + "scope": "packages", + "id": "restorePackageForOrg", + "method": "POST", + "url": "/orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "token", + "description": "package token", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore a package for a user", + "scope": "packages", + "id": "restorePackageForUser", + "method": "POST", + "url": "/users/{username}/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":387039,\"name\":\"0.2.0\",\"url\":\"https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039\",\"package_html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201\",\"license\":\"MIT\",\"created_at\":\"2019-12-01T20:49:29Z\",\"updated_at\":\"2019-12-01T20:49:30Z\",\"description\":\"Octo-name client for Ruby\",\"html_url\":\"https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0\",\"metadata\":{\"package_type\":\"rubygems\"}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List packages for the authenticated user's namespace", + "scope": "packages", + "id": "listPackagesForAuthenticatedUser", + "method": "GET", + "url": "/user/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List packages for an organization", + "scope": "packages", + "id": "listPackagesForOrganization", + "method": "GET", + "url": "/orgs/{org}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/goodbye_docker\"}]" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "List packages for a user", + "scope": "packages", + "id": "listPackagesForUser", + "method": "GET", + "url": "/user/{username}/packages", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "visibility", + "description": "The selected visibility of the packages. Can be one of `public`, `private`, or `internal`. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["public", "private", "internal"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"id\":197,\"name\":\"hello_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"monalisa\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.monalisausercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":1,\"visibility\":\"private\",\"url\":\"https://api.github.com/orgs/github/packages/container/hello_docker\",\"created_at\":\"2020-05-19T22:19:11Z\",\"updated_at\":\"2020-05-19T22:19:11Z\",\"html_url\":\"https://github.com/orgs/github/packages/container/package/hello_docker\"},{\"id\":198,\"name\":\"goodbye_docker\",\"package_type\":\"container\",\"owner\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"User\",\"site_admin\":false},\"version_count\":2,\"visibility\":\"private\",\"url\":\"https://api.github.com/user/monalisa/packages/container/goodbye_docker\",\"created_at\":\"2020-05-20T22:19:11Z\",\"updated_at\":\"2020-05-20T22:19:11Z\",\"html_url\":\"https://github.com/user/monalisa/packages/container/package/goodbye_docker\"}]" } ] - } + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null } ], "renamed": null }, @@ -26715,15 +28566,15 @@ "renamed": null }, { - "name": "Restore a package for an organization", + "name": "Restore a package version for the authenticated user", "scope": "packages", - "id": "restorePackageForOrg", + "id": "restorePackageForUser", "method": "POST", - "url": "/orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", + "url": "/users/{username}/packages/{package_type}/{package_name}/restore{?token}", "isDeprecated": false, "deprecationDate": null, - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -26754,7 +28605,72 @@ "deprecated": null }, { - "name": "org", + "name": "username", + "description": "", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore a package for a user", + "scope": "packages", + "id": "restorePackageForUser", + "method": "POST", + "url": "/users/{username}/packages/{package_type}/{package_name}/restore{?token}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", "description": "", "in": "PATH", "type": "string", @@ -26795,13 +28711,13 @@ { "name": "Restore a package version for the authenticated user", "scope": "packages", - "id": "restorePackageVersionForAuthenticatedUser", + "id": "restorePackageVersionForOrg", "method": "POST", - "url": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "isDeprecated": false, "deprecationDate": null, - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -26831,6 +28747,19 @@ "alias": null, "deprecated": null }, + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "package_version_id", "description": "Unique identifier of the package version.", @@ -26858,15 +28787,15 @@ "renamed": null }, { - "name": "Restore package version for an organization", + "name": "Restore package version for a user", "scope": "packages", - "id": "restorePackageVersionForOrg", + "id": "restorePackageVersionForUser", "method": "POST", - "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "isDeprecated": false, "deprecationDate": null, - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -26897,7 +28826,85 @@ "deprecated": null }, { - "name": "org", + "name": "username", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Restore package version for a user", + "scope": "packages", + "id": "restorePackageVersionForUser", + "method": "POST", + "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + "isDeprecated": false, + "deprecationDate": null, + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", + "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "PATH", + "type": "string", + "required": true, + "enum": ["npm", "maven", "rubygems", "docker", "nuget", "container"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", "description": "", "in": "PATH", "type": "string", @@ -41725,7 +43732,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" + "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" } ] }, @@ -48335,6 +50342,100 @@ ], "renamed": null }, + { + "name": "Lists secret scanning alerts by organization", + "scope": "secretScanning", + "id": "listAlertsForOrg", + "method": "GET", + "url": "/orgs/{org}/secret-scanning/alerts", + "isDeprecated": false, + "deprecationDate": null, + "description": "Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "state", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["open", "resolved"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "secret_type", + "description": "A comma separated list of secret types to return. By default all secret types are returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, { "name": "List secret scanning alerts for a repository", "scope": "secretScanning", diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 33079de0e..6f4757135 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -660,12 +660,18 @@ const Endpoints: EndpointsDefaultsAndDecorations = { deletePackageForOrg: [ "DELETE /orgs/{org}/packages/{package_type}/{package_name}", ], + deletePackageForUser: [ + "DELETE /users/{username}/packages/{package_type}/{package_name}", + ], deletePackageVersionForAuthenticatedUser: [ "DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}", ], deletePackageVersionForOrg: [ "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", ], + deletePackageVersionForUser: [ + "DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], getAllPackageVersionsForAPackageOwnedByAnOrg: [ "GET /orgs/{org}/packages/{package_type}/{package_name}/versions", {}, @@ -708,18 +714,27 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getPackageVersionForUser: [ "GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", ], + listPackagesForAuthenticatedUser: ["GET /user/packages"], + listPackagesForOrganization: ["GET /orgs/{org}/packages"], + listPackagesForUser: ["GET /user/{username}/packages"], restorePackageForAuthenticatedUser: [ "POST /user/packages/{package_type}/{package_name}/restore{?token}", ], restorePackageForOrg: [ "POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", ], + restorePackageForUser: [ + "POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}", + ], restorePackageVersionForAuthenticatedUser: [ "POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", ], restorePackageVersionForOrg: [ "POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", ], + restorePackageVersionForUser: [ + "POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + ], }, projects: { addCollaborator: [ @@ -1330,6 +1345,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getAlert: [ "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", ], + listAlertsForOrg: ["GET /orgs/{org}/secret-scanning/alerts"], listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], updateAlert: [ "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index e4d3e1fc8..bcda05632 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -4734,6 +4734,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + deletePackageForUser: { + ( + params?: RestEndpointMethodTypes["packages"]["deletePackageForUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["deletePackageForUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * @@ -4765,6 +4781,22 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + deletePackageVersionForUser: { + ( + params?: RestEndpointMethodTypes["packages"]["deletePackageVersionForUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["deletePackageVersionForUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Returns all package versions for a package owned by an organization. * @@ -4932,6 +4964,51 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists packages owned by the authenticated user within the user's namespace. + * + * 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. + */ + listPackagesForAuthenticatedUser: { + ( + params?: RestEndpointMethodTypes["packages"]["listPackagesForAuthenticatedUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["listPackagesForAuthenticatedUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all packages in an organization readable by the 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. + */ + listPackagesForOrganization: { + ( + params?: RestEndpointMethodTypes["packages"]["listPackagesForOrganization"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["listPackagesForOrganization"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists all packages in a user's namespace for which the requesting user has access. + * + * 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. + */ + listPackagesForUser: { + ( + params?: RestEndpointMethodTypes["packages"]["listPackagesForUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["listPackagesForUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Restores a package owned by the authenticated user. * @@ -4970,6 +5047,26 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Restores an entire package for a user. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + restorePackageForUser: { + ( + params?: RestEndpointMethodTypes["packages"]["restorePackageForUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["restorePackageForUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Restores a package version owned by the authenticated user. * @@ -5008,6 +5105,26 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Restores a specific package version for a user. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + restorePackageVersionForUser: { + ( + params?: RestEndpointMethodTypes["packages"]["restorePackageVersionForUser"]["parameters"] + ): Promise< + RestEndpointMethodTypes["packages"]["restorePackageVersionForUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; }; projects: { /** @@ -8286,6 +8403,21 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest. + * To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + listAlertsForOrg: { + ( + params?: RestEndpointMethodTypes["secretScanning"]["listAlertsForOrg"]["parameters"] + ): Promise< + RestEndpointMethodTypes["secretScanning"]["listAlertsForOrg"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 3ec75fe62..4570e7668 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -2760,6 +2760,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}"]["response"]; }; + deletePackageForUser: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}"]["response"]; + }; deletePackageVersionForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -2776,6 +2784,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; }; + deletePackageVersionForUser: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; + }; getAllPackageVersionsForAPackageOwnedByAnOrg: { parameters: RequestParameters & Omit< @@ -2864,6 +2880,30 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; }; + listPackagesForAuthenticatedUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/packages"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/packages"]["response"]; + }; + listPackagesForOrganization: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/packages"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/packages"]["response"]; + }; + listPackagesForUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /user/{username}/packages"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /user/{username}/packages"]["response"]; + }; restorePackageForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -2880,6 +2920,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"]["response"]; }; + restorePackageForUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/restore{?token}"]["response"]; + }; restorePackageVersionForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -2896,6 +2944,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"]; }; + restorePackageVersionForUser: { + parameters: RequestParameters & + Omit< + Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"]; + }; }; projects: { addCollaborator: { @@ -4830,6 +4886,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; }; + listAlertsForOrg: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["response"]; + }; listAlertsForRepo: { parameters: RequestParameters & Omit<