Envoyer des packages de symboles

  • Article

Il est possible d’envoyer des packages de symboles (snupkg) à l’aide de l’API NuGet V3. Ces opérations sont basées sur la ressource SymbolPackagePublish trouvée dans l’index de service.

Contrôle de version

La valeur suivante @type est utilisée :

Valeur @type Notes
SymbolPackagePublish/4.9.0 La version initiale

URL de base

L’URL de base des API suivantes est la valeur de la propriété @id de la ressource dans l’index de service de la ressource SymbolPackagePublish/4.9.0 du package. Pour la documentation ci-dessous, l’URL de nuget.org est utilisée. Considérez https://www.nuget.org/api/v2/symbolpackage comme un espace réservé pour la valeur @id trouvée dans l’index de service.

Méthodes HTTP

La méthode HTTP PUT est prise en charge par cette ressource.

Envoyer un package de symboles

nuget.org prend en charge l’envoi de nouveaux formats de packages de symboles (snupkg) à l’aide de l’API suivante.

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

Les packages de symboles avec le même ID et la même version peuvent être envoyés plusieurs fois. Un package de symboles est rejeté dans les cas suivants.

  • Un package avec le même ID et la même version n’existe pas.
  • Un package de symboles avec le même ID et la même version a été envoyé mais n’est pas encore publié.
  • Le package de symboles (snupkg) n’est pas valide (voir contraintes de package de symboles).

Paramètres de la demande

Nom Dans Type Requise Notes
X-NuGet-ApiKey En-tête string Oui Par exemple, X-NuGet-ApiKey: {USER_API_KEY}

La clé API est une chaîne opaque extraite de la source du package par l’utilisateur et configurée dans le client. Aucun format de chaîne particulier n’est obligatoire, mais la longueur de la clé API ne doit pas dépasser une taille raisonnable pour les valeurs d’en-tête HTTP.

Corps de la demande

Le corps de la demande pour l’envoi de symboles est identique au corps de la demande d’une demande d’envoi de package (voir envoi et suppression du package).

Response

Code de statut Signification
201 Le package de symboles a été envoyé avec succès.
400 Le package de symboles fourni n’est pas valide.
401 L’utilisateur n’est pas autorisé à effectuer cette action.
404 Un package correspondant avec l’ID et la version fournis n’existe pas.
409 Un package de symboles avec l’ID fourni et la version fournie a été envoyé mais n’est pas encore disponible.
413 Le package est trop volumineux.