Udostępnij za pośrednictwem

Wypychanie pakietów symboli

  • Artykuł

Istnieje możliwość wypychania pakietów symboli (snupkg) przy użyciu interfejsu API NuGet w wersji 3. Te operacje są oparte na zasobie SymbolPackagePublish znajdującym się w indeksie usługi.

Wersje

Używana jest następująca @type wartość:

@type Wartość Uwagi
SymbolPackagePublish/4.9.0 Wersja początkowa

Podstawowy adres URL

Podstawowym adresem URL dla następujących interfejsów API jest wartość @id właściwości SymbolPackagePublish/4.9.0 zasobu w indeksie usługi źródła pakietu. W poniższej dokumentacji jest używany adres URL witryny nuget.org. Rozważmy https://www.nuget.org/api/v2/symbolpackage jako symbol zastępczy @id wartości znalezionej w indeksie usługi.

Metody HTTP

Metoda HTTP jest obsługiwana PUT przez ten zasób.

Wypychanie pakietu symboli

nuget.org obsługuje wypychanie nowego formatu pakietów symboli (snupkg) przy użyciu następującego interfejsu API.

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

Pakiety symboli o tym samym identyfikatorze i wersji można przesyłać wiele razy. Pakiet symboli zostanie odrzucony w następujących przypadkach.

Parametry żądania

Nazwisko W Typ Wymagania Uwagi
X-NuGet-ApiKey Nagłówek string tak Na przykład X-NuGet-ApiKey: {USER_API_KEY}

Klucz interfejsu API jest nieprzezroczystym ciągiem uzyskanym ze źródła pakietu przez użytkownika i skonfigurowanym do klienta. Nie jest wymagany żaden określony format ciągu, ale długość klucza interfejsu API nie powinna przekraczać rozsądnego rozmiaru wartości nagłówka HTTP.

Treść żądania

Treść żądania wypychania symbolu jest taka sama jak w treści żądania wypychania (zobacz wypychanie i usuwanie pakietu).

Response

Kod stanu Znaczenie
201 Pakiet symboli został pomyślnie wypchnięty.
400 Podany pakiet symboli jest nieprawidłowy.
401 Użytkownik nie ma uprawnień do wykonania tej akcji.
404 Odpowiedni pakiet z podanym identyfikatorem i wersją nie istnieje.
409 Pakiet symboli z podanym identyfikatorem i wersją został wypchnięty, ale nie jest jeszcze dostępny.
413 Pakiet jest za duży.