Partilhar via

Enviar pacotes de símbolos por push

  • Artigo

É possível enviar pacotes de símbolos (snupkg) usando a API do NuGet V3. Essas operações são baseadas no recurso SymbolPackagePublish encontrado no índice de serviço.

Controle de versão

O seguinte valor @type é usado:

@type valor Observações
SymbolPackagePublish/4.9.0 O lançamento inicial

URL base

A URL base para as APIs a seguir é o valor da propriedade @id do recurso SymbolPackagePublish/4.9.0 no índice de serviço da origem do pacote. Para a documentação abaixo, a URL do nuget.org é usada. Considere https://www.nuget.org/api/v2/symbolpackage como um espaço reservado para o valor @id encontrado no índice de serviço.

Métodos HTTP

O método HTTP PUT é suportado por este recurso.

Enviar um pacote de símbolos por push

O nuget.org oferece suporte ao envio por push de novo formato de pacotes de símbolos (snupkg) usando a seguinte API.

PUT https://www.nuget.org/api/v2/symbolpackage

Pacotes de símbolos com a mesma ID e versão podem ser enviados várias vezes. Um pacote de símbolos será rejeitado nos seguintes casos.

  • Um pacote com a mesma ID e versão não existe.
  • Um pacote de símbolos com a mesma ID e versão foi enviado, mas ainda não foi publicado.
  • O pacote de símbolos (snupkg) é inválido (consulte restrições de pacotes de símbolos).

Parâmetros da solicitação

Nome Em Tipo Obrigatória Observações
X-NuGet-ApiKey Cabeçalho string sim Por exemplo, X-NuGet-ApiKey: {USER_API_KEY}

A chave de API é uma cadeia de caracteres opaca obtida da origem do pacote pelo usuário e configurada para o cliente. Nenhum formato de cadeia de caracteres específico é obrigatório, mas o comprimento da chave de API não deve exceder um tamanho razoável para valores de cabeçalho HTTP.

Corpo da solicitação

O corpo da solicitação para o envio por push de símbolo é o mesmo que o corpo da solicitação de uma solicitação por push de pacote (consulte envio e exclusão de pacote).

Resposta

Código do Status Significado
201 O pacote de símbolos foi enviado por push com êxito.
400 O pacote de símbolos fornecido é inválido.
401 O usuário não está autorizado a executar essa ação.
404 Não existe um pacote correspondente com a ID e a versão fornecidas.
409 Um pacote de símbolos com a ID e a versão fornecidas foi enviado, mas ainda não está disponível.
413 O pacote é grande demais.