报告滥用 URL 模板
客户端可生成可供用户用于报告特定包滥用情况的 URL。 当包源想启用所有客户端体验(甚至包括第三方)从而将滥用报告委托给包源时,此功能非常有用。
用于生成此 URL 的资源是在服务索引中找到的 ReportAbuseUriTemplate
资源。
版本控制
使用了以下 @type
值:
值@type | 说明 |
---|---|
ReportAbuseUriTemplate/3.0.0-beta | 初始版本 |
ReportAbuseUriTemplate/3.0.0-rc | ReportAbuseUriTemplate/3.0.0-beta 的别名 |
URL 模板
以下 API 的 URL 是与其中一个上述资源 @type
值关联的 @id
属性的值。
HTTP 方法
尽管客户端不打算代表用户向报告滥用 URL 发出请求,但网页应支持 GET
方法,从而允许在 Web 浏览器中轻松打开已单击的 URL。
构造 URL
由于存在已知的包 ID 和版本,客户端实现可构造用于访问 Web 接口的 URL。 客户端实现应向用户显示此已构造 URL(或可单击链接),以便他们能打开指向 URL 的 Web 浏览器并发出所有必要的滥用报告。 滥用报告表单的实现由服务器实现确定。
@id
的值是包含以下任意占位符标记的 URL 字符串:
URL 占位符
名称 | 类型 | 必须 | 注释 |
---|---|---|---|
{id} |
string | 否 | 要为其报告滥用的包 ID |
{version} |
string | 否 | 要为其报告滥用的包版本 |
服务器实现所解释的 {id}
和 {version}
值必须不区分大小写,且不区分版本是否已规范化。
例如,nuget.org 的报告滥用模板如下所示:
https://www.nuget.org/packages/{id}/{version}/ReportAbuse
如果客户端实现需显示 NuGet.Versioning 4.3.0 报告滥用表单的链接,它则会生成以下 URL 并将其提供给用户:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0/ReportAbuse