Modelo de URL Notificar abuso

  • Artículo

Un cliente puede generar una dirección URL que el usuario podrá utilizar para notificar acerca de un abuso relacionado con un paquete específico. Esto resulta útil cuando un origen de paquete desea habilitar todas las experiencias de cliente (incluidas las de terceros) para delegar los informes de abuso al origen del paquete.

El recurso que se utiliza para generar esta URL es el recurso ReportAbuseUriTemplate que se encuentra en el índice de servicio.

Control de versiones

Se usan los siguientes valores @type:

Valor de @type Notas
ReportAbuseUriTemplate/3.0.0-beta La versión inicial
ReportAbuseUriTemplate/3.0.0-rc Alias de ReportAbuseUriTemplate/3.0.0-beta

URL template

La dirección URL de la siguiente API es el valor de la propiedad @id asociada a uno de los valores @type de los recursos mencionados anteriormente.

Métodos HTTP

Aunque el cliente no está pensado para realizar solicitudes a la dirección URL Notificar abuso en nombre del usuario, la página web debe admitir el método GET para que, cuando un usuario haga clic en una dirección URL, esta se abra fácilmente en un navegador web.

Construcción de la dirección URL

Dada una versión y un id. de paquete conocidos, la implementación del cliente puede construir una dirección URL que se utilice para acceder a una interfaz web. La implementación del cliente debe mostrar al usuario esta dirección URL construida (o vínculo en el que se puede hacer clic), lo que le permite abrir un navegador web que le lleve a la dirección URL y realizar cualquier informe de abuso necesario. La implementación del formulario de informe de abuso viene determinada por la implementación del servidor.

El valor de @id es una cadena de dirección URL que contiene cualquiera de los siguientes tokens de marcador de posición:

Marcadores de posición de dirección URL

Nombre Type Obligatorio Notas
{id} string no Id. del paquete sobre el que se va a notificar un abuso
{version} string no Versión del paquete sobre el que se va a notificar un abuso

Los valores {id} y {version} interpretados por la implementación del servidor deben distinguir entre mayúsculas y minúsculas, y no distinguir si la versión está normalizada.

Por ejemplo, la plantilla Notificar abuso de nuget.org tiene este aspecto:

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

Si la implementación del cliente necesita mostrar un vínculo al formulario de informe de abuso para NuGet.Versioning 4.3.0, generaría la siguiente dirección URL y la proporcionaría al usuario:

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