Paquetes de símbolos de inserción

  • Artículo

Es posible insertar paquetes de símbolos (snupkg) mediante la API V3 de NuGet. Estas operaciones se basan en el recurso SymbolPackagePublish que se encuentra en el índice de servicio.

Control de versiones

Se utiliza el siguiente valor de @type:

Valor de @type Notas
SymbolPackagePublish/4.9.0 La versión inicial

URL base

La dirección URL base de las siguientes API es el valor de la propiedad @id del recurso SymbolPackagePublish/4.9.0 que se encuentra en el índice de servicio del origen del paquete. Para obtener la documentación que mostramos a continuación, es necesario utilizar la dirección URL de nuget.org. Considera https://www.nuget.org/api/v2/symbolpackage como marcador de posición para el valor @id ubicado en el índice de servicio.

Métodos HTTP

Este recurso admite el método HTTP PUT.

Inserción de un paquete de símbolos

nuget.org admite la inserción de un nuevo formato de paquetes de símbolos (snupkg) mediante la siguiente API.

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

Los paquetes de símbolos con el mismo id. y versión se pueden enviar varias veces. Un paquete de símbolos se rechazará en los siguientes casos.

  • No existe un paquete con el mismo id. y versión.
  • Se ha insertado un paquete de símbolos con el mismo id. y versión, pero aún no se ha publicado.
  • El paquete de símbolos (snupkg) no es válido (consulta las restricciones de paquetes de símbolos).

Parámetros de solicitud

Nombre En Tipo Obligatorio Notas
X-NuGet-ApiKey Encabezado string sí Por ejemplo: X-NuGet-ApiKey: {USER_API_KEY}

La clave de API es una cadena opaca extraída del origen del paquete por el usuario y configurada en el cliente. No se exige ningún formato de cadena determinado, pero la longitud de la clave de API no debe superar un tamaño razonable para los valores de encabezado HTTP.

Cuerpo de la solicitud

El cuerpo de la solicitud para la inserción de símbolos es el mismo que el cuerpo de la solicitud de inserción de paquetes (consulta inserción y eliminación de paquetes).

Respuesta

Código de estado Significado
201 El paquete de símbolos se ha insertado correctamente.
400 El paquete de símbolos proporcionado no es válido.
401 El usuario no está autorizado para realizar esta acción.
404 No existe un paquete que se corresponda con el id. y la versión proporcionados.
409 Se ha insertado un paquete de símbolos con el id. y la versión proporcionados, pero aún no está disponible.
413 El paquete es demasiado grande.