Push-Symbolpakete

  • Artikel

Es ist möglich, Mithilfe der NuGet V3-API Symbolepakete (snupkg) zu pushen. Diese Vorgänge basieren auf der im Dienstindex gefundenen Ressource SymbolPackagePublish.

Versionsverwaltung

Der folgende @type Wert wird verwendet:

Wert vom Typ @type Hinweise
SymbolPackagePublish/4.9.0 Erstrelease

Basis-URL

Die Basis-URL für die folgenden APIs ist der Wert der @id Eigenschaft der SymbolPackagePublish/4.9.0 Ressource im Dienstindex der Paketquelle. Für die nachstehende Dokumentation wird die URL von nuget.org verwendet. Betrachten Sie https://www.nuget.org/api/v2/symbolpackage als Platzhalter für den @id-Wert im Dienstindex.

HTTP-Methoden

Die PUT HTTP-Methode wird von dieser Ressource unterstützt.

Ein Symbolpaket verschieben

nuget.org unterstützt das Pushen des neuen Symbolpaketformats (snupkg) mithilfe der folgenden API.

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

Symbolpakete mit derselben ID und Version können mehrmals übermittelt werden. In den folgenden Fällen wird ein Symbolpaket abgelehnt.

  • Ein Paket mit derselben ID und Version ist nicht vorhanden.
  • Ein Symbolpaket mit derselben ID und Version wurde pushed, aber noch nicht veröffentlicht.
  • Das Symbolpaket (snupkg) ist ungültig (siehe Symbolpaketeinschränkungen).

Anforderungsparameter

Name Geben Sie in type Erforderlich Hinweise
X-NuGet-ApiKey Header Zeichenfolge ja Beispiel: X-NuGet-ApiKey: {USER_API_KEY}

Der API-Schlüssel ist eine undurchsichtige Zeichenfolge, die vom Benutzer aus der Paketquelle abgerufen und in den Client konfiguriert wurde. Es ist kein bestimmtes Zeichenfolgenformat vorgeschrieben, aber die Länge des API-Schlüssels darf keine angemessene Größe für HTTP-Headerwerte überschreiten.

Anforderungstext

Der Anforderungstext für den Symbol-Push entspricht dem Anforderungstext einer Paket-Pushanforderung (siehe Paket-Push und Löschen).

Antwort

Statuscode Bedeutung
201 Das Symbolpaket wurde erfolgreich verschoben.
400 Das bereitgestellte Symbolpaket ist ungültig.
401 Der Benutzer ist nicht berechtigt, diese Aktion auszuführen.
404 Ein entsprechendes Paket mit der bereitgestellten ID und Version ist nicht vorhanden.
409 Ein Symbolpaket mit der bereitgestellten ID und Version wurde pusht, ist aber noch nicht verfügbar.
413 Die Nachricht ist zu lang.