Šablona adresy URL pro ohlášení zneužití
Klient může vytvořit adresu URL, kterou může uživatel použít k nahlášení zneužití konkrétního balíčku. To je užitečné, když zdroj balíčku chce povolit všem klientským prostředím (dokonce i třetí straně) delegovat hlášení o zneužití do zdroje balíčku.
Prostředek použitý k sestavení této adresy URL je prostředek, který ReportAbuseUriTemplate
se nachází v indexu služby.
Vytváření verzí
Používají se následující @type
hodnoty:
@type Hodnotu | Notes |
---|---|
ReportAbuseUriTemplate/3.0.0-beta | Počáteční verze |
ReportAbuseUriTemplate/3.0.0-rc | Alias of ReportAbuseUriTemplate/3.0.0-beta |
Šablona adresy URL
Adresa URL pro následující rozhraní API je hodnota @id
vlastnosti přidružené k jedné z výše uvedených hodnot prostředků @type
.
Metody HTTP
I když klient není určen k odesílání žádostí na adresu URL zneužití sestavy jménem uživatele, webová stránka by měla podporovat metodu GET
, která umožňuje snadné otevření klikané adresy URL ve webovém prohlížeči.
Vytvoření adresy URL
Vzhledem k známému ID a verzi balíčku může implementace klienta vytvořit adresu URL použitou pro přístup k webovému rozhraní. Implementace klienta by měla zobrazit tuto konstruovanou adresu URL (nebo odkaz umožňující kliknutí) uživateli, který mu umožní otevřít webový prohlížeč na adresu URL a provést případnou zprávu o zneužití. Implementace formuláře zprávy o zneužití je určena implementací serveru.
Hodnota @id
je řetězec adresy URL obsahující některý z následujících zástupných tokenů:
Zástupné symboly adres URL
Name | Type | Požaduje se | Notes |
---|---|---|---|
{id} |
string | ne | ID balíčku pro nahlášení zneužití pro |
{version} |
string | ne | Verze balíčku, která ohlásí zneužití pro |
{version}
Hodnoty {id}
a interpretované implementací serveru musí být nerozlišující malá a malá písmena a nerozlišují se na to, zda je verze normalizována.
Například šablona zneužití sestavy nuget.org vypadá takto:
https://www.nuget.org/packages/{id}/{version}/ReportAbuse
Pokud implementace klienta potřebuje zobrazit odkaz na formulář zneužití sestavy pro NuGet.Versioning 4.3.0, vytvoří následující adresu URL a poskytne ji uživateli:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0/ReportAbuse