PackageVersionDescription

Details about a package version.

displayName

The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

format

The format of the package version.

Type: String

Required: No

homePage

The homepage associated with the package.

Type: String

Required: No

licenses

Information about licenses associated with the package version.

Type: Array of LicenseInfo objects

Required: No

namespace

The namespace of the package version. The package component that specifies its namespace depends on its type. For example:

The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: No

origin

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

Type: PackageVersionOrigin object

Required: No

packageName

The name of the requested package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: No

publishedTime

A timestamp that contains the date and time the package version was published.

Type: Timestamp

Required: No

revision

The revision of the package version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: \S+

Required: No

sourceCodeRepository

The repository for the source code in the package version, or the source code used to build it.

Type: String

Required: No

status

A string that contains the status of the package version.

Type: String

Valid Values: Archived | Disposed | Published | Unfinished | Unlisted

Required: No

summary

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

Type: String

Required: No

version

The version of the package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: No

PackageVersionDescription

Contents

See Also