Modelo de URL para relatar abuso

  • Artigo

É possível que um cliente crie uma URL que possa ser usada pelo usuário para relatar abuso sobre um pacote específico. Isso é útil quando uma origem de pacote deseja permitir que todas as experiências do cliente (mesmo terceiros) deleguem relatórios de abuso à origem do pacote.

O recurso usado para criar essa URL é o recurso ReportAbuseUriTemplate encontrado no índice de serviço.

Controle de versão

Os seguintes valores de @type são usados:

@type valor Observações
ReportAbuseUriTemplate/3.0.0-beta O lançamento inicial
ReportAbuseUriTemplate/3.0.0-rc Alias de ReportAbuseUriTemplate/3.0.0-beta

Modelo do URL

A URL da API a seguir é o valor da propriedade @id associada a um dos valores de recurso @type mencionados anteriormente.

Métodos HTTP

Embora o cliente não se destine a fazer solicitações para a URL para relatar abuso em nome do usuário, a página da Web deve oferecer suporte ao método GET para permitir que uma URL clicada seja facilmente aberta em um navegador da Web.

Criar a URL

Dada uma ID e versão de pacote conhecidas, a implementação do cliente pode criar uma URL usada para acessar uma interface da Web. A implementação do cliente deve exibir essa URL criada (ou link clicável) para o usuário, permitindo que ele abra um navegador da Web para a URL e faça qualquer relatório de abuso necessário. A implementação do formulário de relatório de abuso é determinada pela implementação do servidor.

O valor do é @id uma cadeia de caracteres de URL que contém qualquer um dos seguintes tokens de espaço reservado:

Espaços reservados de URL

Nome Digitar Obrigatória Observações
{id} string não A ID do pacote para relatar abuso por
{version} string não A versão do pacote para relatar abuso por

Os valores {id} e {version} interpretados pela implementação do servidor não devem diferenciar maiúsculas de minúsculas e não diferenciar se a versão é normalizada.

Por exemplo, o modelo de relatar abuso do nuget.org tem a seguinte aparência:

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

Se a implementação do cliente precisar exibir um link do formulário para relatar abuso para o NuGet.Versioning 4.3.0, ela produzirá a seguinte URL e a fornecerá ao usuário:

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