Templat README Uri
Klien dapat membuat URL yang dapat digunakan untuk mengunduh README untuk paket tertentu. Ini akan memungkinkan klien untuk merender README paket tanpa mengunduh seluruh paket.
Sumber daya yang digunakan untuk membangun URL ini adalah sumber daya ReadmeUriTemplate yang ditemukan dalam indeks layanan .
Penerapan versi
Nilai @type berikut digunakan:
| nilai @type | Catatan |
|---|---|
| ReadmeUriTemplate/6.13.0 | Rilis awal |
Templat URL
URL untuk API berikut adalah nilai properti @id yang terkait dengan salah satu nilai @type sumber daya yang disebutkan di atas.
Metode HTTP
URL yang dibuat harus mendukung metode HTTP GET
Membuat URL
Mengingat ID dan versi paket yang diketahui, implementasi klien dapat membuat URL untuk mengunduh README.
Nilai @id adalah string URL yang berisi salah satu token tempat penampung berikut:
Tempat penampung URL
| Nama | Jenis | Diperlukan | Catatan |
|---|---|---|---|
{lower_id} |
tali | Ya | ID paket, huruf kecil |
{lower_version} |
tali | Ya | Versi paket, huruf kecil |
Baik lower_id maupun lower_version diturunkan menggunakan aturan yang diterapkan oleh . NET metode System.String.ToLowerInvariant().
lower_version adalah versi paket yang diinginkan yang dinormalisasi menggunakan versi NuGet aturan normalisasi. Ini berarti bahwa metadata build yang diizinkan oleh spesifikasi SemVer 2.0.0 harus dikecualikan dalam kasus ini.
Isi respons
Jika paket memiliki readme, kode status 200 dikembalikan. Isi respons akan menjadi konten readme itu sendiri.
Jika paket tidak memiliki readme, kode status 404 dikembalikan.