Get a package version for a user | Sample

4 parameters

package_typestringrequired

The type of supported package. 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.

Allowed:npmmavenrubygemsdockernugetcontainer

package_namestringrequired

The name of the package.

package_version_idintegerrequired

Unique identifier of the package version.

usernamestringrequired

The handle for the GitHub user account.

1 status code

200Response

idintegerrequired

Unique identifier of the package version.

namestringrequired

The name of the package version.

urlstringrequired

package_html_urlstringrequired

html_urlstringoptional

licensestringoptional

descriptionstringoptional

created_atstringrequired

updated_atstringrequired

deleted_atstringoptional

metadataobjectoptional

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.versions.get({
  username: "octocat",
  packageType: "example",
  packageName: "Untitled",
  packageVersionId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "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"
  }
}

Was this helpful?

Request

Response