Edit

Report abuse URL template

  • Article

It is possible for a client to build a URL that can be used by the user to report abuse about a specific package. This is useful when a package source wants to enable all client experiences (even 3rd party) to delegate abuse reports to the package source.

The resource used for building this URL is the ReportAbuseUriTemplate resource found in the service index.

Versioning

The following @type values are used:

@type value Notes
ReportAbuseUriTemplate/3.0.0-beta The initial release
ReportAbuseUriTemplate/3.0.0-rc Alias of ReportAbuseUriTemplate/3.0.0-beta

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 report abuse 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 make any necessary abuse report. The implementation of the abuse report form is determined by the server implementation.

The value of the @id is a URL string containing any of the following placeholder tokens:

URL placeholders

Name Type Required Notes
{id} string no The package ID to report abuse for
{version} string no The package version to report abuse for

The {id} and {version} values interpreted by the server implementation must be case insensitive and not sensitive to whether the version is normalized.

For example, nuget.org's report abuse template looks like this:

https://www.nuget.org/packages/{id}/{version}/ReportAbuse

If the client implementation needs to display a link to the report abuse form 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/ReportAbuse