README-URI-sjabloon
Het is mogelijk dat een client een URL bouwt die kan worden gebruikt om een README voor een specifiek pakket te downloaden. Hierdoor kunnen de clients de LEESMIJ van het pakket weergeven zonder het hele pakket te downloaden.
De resource die wordt gebruikt voor het bouwen van deze URL, is de ReadmeUriTemplate resource in de service-index.
Versiebeheer
De volgende @type waarden worden gebruikt:
| @type waarde | Notities |
|---|---|
| ReadmeUriTemplate/6.13.0 | De eerste release |
URL-sjabloon
De URL voor de volgende API is de waarde van de eigenschap @id die is gekoppeld aan een van de bovengenoemde resource @type waarden.
HTTP-methoden
De samengestelde URL moet ondersteuning bieden voor de HTTP-methode GET
De URL maken
Op basis van een bekende pakket-id en -versie kan de client-implementatie een URL samenstellen om de README te downloaden.
De waarde van de @id is een URL-tekenreeks die een van de volgende tijdelijke aanduidingstokens bevat:
Tijdelijke aanduidingen voor URL's
| Naam | Type | Vereist | Notities |
|---|---|---|---|
{lower_id} |
snaar | ja | De pakket-id, in kleine letters |
{lower_version} |
snaar | ja | De pakketversie, lager |
Zowel lower_id als lower_version worden verlaagd met behulp van de regels die worden geïmplementeerd door . NET's
System.String.ToLowerInvariant() methode.
De lower_version is de gewenste pakketversie die is genormaliseerd met behulp van nuGet-versie normalisatieregels. Dit betekent dat buildmetagegevens die zijn toegestaan door de SemVer 2.0.0-specificatie moeten worden uitgesloten in dit geval.
Hoofdtekst van antwoord
Als het pakket een leesmij heeft, wordt er een 200-statuscode geretourneerd. De hoofdtekst van het antwoord is de leesmij-inhoud zelf.
Als het pakket geen leesmij heeft, wordt er een 404-statuscode geretourneerd.