Szablon adresu URL zgłaszania nadużyć
Istnieje możliwość utworzenia przez klienta adresu URL, który może być używany przez użytkownika do zgłaszania nadużyć dotyczących określonego pakietu. Jest to przydatne, gdy źródło pakietu chce włączyć wszystkie środowiska klienta (nawet innych firm) do delegowania raportów nadużyć do źródła pakietu.
Zasób używany do tworzenia tego adresu URL jest zasobem ReportAbuseUriTemplate znajdującym się w indeksie usługi.
Wersje
Używane są następujące @type wartości:
| @type Wartość | Uwagi |
|---|---|
| ReportAbuseUriTemplate/3.0.0-beta | Wersja początkowa |
| ReportAbuseUriTemplate/3.0.0-rc | Alias of ReportAbuseUriTemplate/3.0.0-beta |
Szablon adresu URL
Adres URL następującego interfejsu API to wartość @id właściwości skojarzonej z jedną z wyżej wymienionych wartości zasobów @type .
Metody HTTP
Mimo że klient nie ma na celu wysłania żądań do adresu URL nadużyć w raporcie w imieniu użytkownika, strona internetowa powinna obsługiwać GET metodę umożliwiającą łatwe otwieranie klikniętego adresu URL w przeglądarce internetowej.
Konstruowanie adresu URL
Biorąc pod uwagę znany identyfikator i wersję pakietu, implementacja klienta może utworzyć adres URL używany do uzyskiwania dostępu do interfejsu internetowego. Implementacja klienta powinna wyświetlić ten skonstruowany adres URL (lub link możliwy do kliknięcia) użytkownikowi, co umożliwi mu otwarcie przeglądarki internetowej pod adresem URL i zgłoszenie wszelkich niezbędnych nadużyć. Implementacja formularza raportu nadużyć jest określana przez implementację serwera.
Wartość parametru @id to ciąg adresu URL zawierający dowolny z następujących tokenów zastępczych:
Symbole zastępcze adresu URL
| Nazwisko | Type | Wymagania | Uwagi |
|---|---|---|---|
{id} |
string | nie | Identyfikator pakietu do zgłaszania nadużyć |
{version} |
string | nie | Wersja pakietu do zgłaszania nadużyć |
Wartości {id} i {version} interpretowane przez implementację serwera muszą być bez uwzględniania wielkości liter i nie są wrażliwe na to, czy wersja jest znormalizowana.
Na przykład szablon nadużyć dotyczących raportów nuget.org wygląda następująco:
https://www.nuget.org/packages/{id}/{version}/ReportAbuse
Jeśli implementacja klienta musi wyświetlić link do formularza zgłaszania nadużyć dla nuGet.Versioning 4.3.0, powinien on utworzyć następujący adres URL i podać go użytkownikowi:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0/ReportAbuse