Шаблон URL-адреса для отчета о злоупотреблении
Клиент может создать URL-адрес, который может использоваться пользователем для сообщения о злоупотреблении конкретным пакетом. Это полезно, если источник пакета хочет включить все клиентские возможности (даже 3-й стороны), чтобы делегировать отчеты о злоупотреблениях в источник пакета.
Ресурс, используемый для создания этого URL-адреса, является ресурсомReportAbuseUriTemplate
, найденным в индексе службы.
Управление версиями
Допустимы следующие значения @type
:
Значение @type | Примечания. |
---|---|
ReportAbuseUriTemplate/3.0.0-beta | Начальный выпуск |
ReportAbuseUriTemplate/3.0.0-rc | Псевдоним ReportAbuseUriTemplate/3.0.0-beta |
Шаблон URL
URL-адрес для следующего API — это значение @id
свойства, связанного с одним из указанных выше упоминание значений ресурсов@type
.
Методы HTTP
Хотя клиент не предназначен для отправки запросов к URL-адресу о злоупотреблении отчетом от имени пользователя, веб-страница должна поддерживать GET
метод, чтобы разрешить доступ к URL-адресу щелчка в веб-браузере.
Создание URL-адреса
Учитывая известный идентификатор пакета и версию, реализация клиента может создать URL-адрес, используемый для доступа к веб-интерфейсу. Реализация клиента должна отображать этот созданный URL-адрес (или ссылку, доступную для щелчка) пользователю, позволяя им открыть веб-браузер на URL-адрес и сделать любой необходимый отчет о злоупотреблении. Реализация формы отчета о злоупотреблении определяется реализацией сервера.
Значением @id
является строка URL-адреса, содержащая любой из следующих маркеров заполнителя:
Заполнители URL-адресов
Имя. | Type | Обязательное поле | Примечания. |
---|---|---|---|
{id} |
строка | no | Идентификатор пакета для сообщения о злоупотреблении |
{version} |
строка | no | Версия пакета для сообщения о злоупотреблении |
Значения {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