報告濫用URL範本
用戶端可以建置 URL,供使用者用來報告特定套件的濫用狀況。 當套件來源想要讓所有客戶端體驗(甚至是第三方)將濫用報告委派給套件來源時,這非常有用。
用來建置此 URL 的資源是ReportAbuseUriTemplate
服務索引中找到的資源。
版本控制
使用下列 @type
值:
@type 值 | 備註 |
---|---|
ReportAbuseUriTemplate/3.0.0-beta | 初始版本 |
ReportAbuseUriTemplate/3.0.0-rc | 的別名 ReportAbuseUriTemplate/3.0.0-beta |
URL 範本
下列 API 的 URL 是 @id
與上述其中一個資源 @type
值相關聯的 屬性值。
HTTP 方法
雖然用戶端不打算代表使用者向報告濫用 URL 提出要求,但網頁應該支援 GET
方法,以允許在網頁瀏覽器中輕鬆開啟點擊的 URL。
建構 URL
假設有已知的套件標識碼和版本,用戶端實作可以建構用來存取 Web 介面的 URL。 用戶端實作應該向用戶顯示這個建構的 URL(或可點選連結),讓使用者能夠開啟網頁瀏覽器至 URL,並提出任何必要的濫用報告。 濫用報告表單的實作是由伺服器實作所決定。
的值 @id
是包含下列任何佔位元令牌的 URL 字串:
URL 佔位元
名稱 | 類型 | 必要 | 備註 |
---|---|---|---|
{id} |
string | 否 | 要回報濫用的套件標識碼 |
{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