Modèle d’URL de signalement d’abus

  • Article

Il est possible qu’un client crée une URL qui peut être utilisée par l’utilisateur pour signaler des abus sur un package spécifique. Cela est utile lorsqu’une source de package souhaite autoriser toutes les expériences client (même tierces) à déléguer des signalements d’un abus à la source du package.

La ressource utilisée pour générer cette URL est la ressource ReportAbuseUriTemplate trouvée dans l’index de service.

Contrôle de version

Les valeurs @type suivantes sont utilisées :

Valeur @type Notes
ReportAbuseUriTemplate/3.0.0-beta La version initiale
ReportAbuseUriTemplate/3.0.0-rc Alias de ReportAbuseUriTemplate/3.0.0-beta

URL template

L’URL de l’API suivante est la valeur de la propriété @id associée à l’une des valeurs de ressource @type mentionnées ci-dessus.

Méthodes HTTP

Bien que le client n’ait pas l’intention d’envoyer des demandes à l’URL de signalement d’un abus pour le compte de l’utilisateur, la page web doit prendre en charge la méthode GET pour autoriser l’ouverture facile d’une URL cliquée dans un navigateur web.

Construire l’URL

Étant donné un ID de package et une version connus, l’implémentation du client peut construire une URL utilisée pour accéder à une interface web. L’implémentation du client doit afficher cette URL construite (ou lien cliquable) à l’utilisateur lui permettant d’ouvrir un navigateur web à l’URL et de rendre tout signalement d’un abus nécessaire. L’implémentation du formulaire de signalement d’un abus est déterminée par l’implémentation du serveur.

La valeur de @id est une chaîne d’URL contenant l’un des jetons d’espace réservé suivants :

Espaces réservés d’URL.

Nom Type Requise Notes
{id} string non ID de package pour signaler un abus pour
{version} string non Version du package pour signaler un abus pour

Les valeurs interprétées {id} et {version} par l’implémentation du serveur doivent être insensibles à la casse et ne respectent pas si la version est normalisée.

Par exemple, le modèle de signalement d’un abus nuget.org ressemble à ceci :

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

Si l’implémentation du client doit afficher un lien vers le formulaire de signalement d’un abus pour NuGet.Versioning 4.3.0, elle génère l’URL suivante et la fournit à l’utilisateur :

https://www.nuget.org/packages/NuGet.Versioning/4.3.0/ReportAbuse