Package details URL template
It is possible for a client to build a URL that can be used by the user to see more package details in their web browser. This is useful when a package source wants to show additional information about a package that may not fit within the scope of what the NuGet client application shows.
The resource used for building this URL is the PackageDetailsUriTemplate resource found in the
service index.
Versioning
The following @type values are used:
| @type value | Notes |
|---|---|
| PackageDetailsUriTemplate/5.1.0 | The initial release |
URL template
The URL for the following API is the value of the @id property associated with one of the aforementioned
resource @type values.
HTTP methods
Although the client is not intended to make requests to the package details URL on behalf of the user, the web page
should support the GET method to allow a clicked URL to be easily opened in a web browser.
Construct the URL
Given a known package ID and version, the client implementation can construct a URL used to access a web interface. The client implementation should display this constructed URL (or clickable link) to the user allowing them to open a web browser to the URL and to learn more about the package. The contents of the package details page is determined by the server implementation.
The URL must be an absolute URL and the scheme (protocol) must be HTTPS.
The value of the @id in the service index is a URL string containing any of the following placeholder tokens:
URL placeholders
| Name | Type | Required | Notes |
|---|---|---|---|
{id} |
string | no | The package ID to get details for |
{version} |
string | no | The package version to get details for |
The server should accept {id} and {version} values with any casing. In addition, the server should not be sensitive
to whether the version is
normalized. In other
words, the server should accept also accept non-normalized versions.
For example, nuget.org's package details template looks like this:
https://www.nuget.org/packages/{id}/{version}
If the client implementation needs to display a link to the package details for NuGet.Versioning 4.3.0, it would produce the following URL and provide it to the user:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0