Modelo README Uri
É possível para um cliente criar uma URL que pode ser usada para baixar um LEIA-ME para um pacote específico. Isso permitirá que os clientes processem o LEIA-ME do pacote sem baixar o pacote inteiro.
O recurso usado para criar essa URL é o recurso ReadmeUriTemplate encontrado no índice de serviço .
Controle de versão
São utilizados os seguintes valores @type:
| Valor @type | Observações |
|---|---|
| ReadmeUriTemplate/6.13.0 | A versão inicial |
Modelo de URL
A URL da API a seguir é o valor da propriedade @id associada a um dos valores de @type de recursos acima mencionados.
Métodos HTTP
A URL construída deve suportar o método HTTP GET
Construir o URL
Dado um ID de pacote e uma versão conhecidos, a implementação do cliente pode construir uma URL para baixar o LEIA-ME.
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 para URL
| Designação | Tipo | Necessário | Observações |
|---|---|---|---|
{lower_id} |
string | Sim | O ID do pacote, com caixa baixa |
{lower_version} |
string | Sim | A versão do pacote, com caixa baixa |
Tanto lower_id quanto lower_version são reduzidos usando as regras implementadas pela . NET's
System.String.ToLowerInvariant() método.
O lower_version é a versão de pacote desejada normalizada usando a versão do NuGet, regras de normalização. Isso significa que os metadados de compilação permitidos pela especificação SemVer 2.0.0 devem ser excluídos neste caso.
Corpo de resposta
Se o pacote tiver um readme, um código de status 200 será retornado. O corpo da resposta será o próprio conteúdo do readme.
Se o pacote não tiver um readme, um código de status 404 será retornado.