Balíčky symbolů nabízených oznámení

Článek
12/14/2023

Balíčky symbolů (snupkg) je možné nasdílet pomocí rozhraní API NuGet v3. Tyto operace jsou založené na SymbolPackagePublish prostředku nalezeného v indexu služby.

Vytváření verzí

Použije se následující @type hodnota:

@type Hodnotu	Notes
SymbolPackagePublish/4.9.0	Počáteční verze

Základní adresa URL

Základní adresa URL pro následující rozhraní API je hodnota @id vlastnosti SymbolPackagePublish/4.9.0 prostředku v indexu služby zdroje balíčku. V následující dokumentaci se používá adresa URL nuget.org. Zvažte https://www.nuget.org/api/v2/symbolpackage jako zástupný symbol hodnoty @id nalezené v indexu služby.

Metody HTTP

Tento PUT prostředek podporuje metodu HTTP.

Nasdílení balíčku symbolů

nuget.org podporuje nabízení nového formátu balíčků symbolů (snupkg) pomocí následujícího rozhraní API.

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

Balíčky symbolů se stejným ID a verzí je možné odeslat vícekrát. Balíček symbolů bude odmítnut v následujících případech.

Balíček se stejným ID a verzí neexistuje.
Balíček symbolů se stejným ID a verzí se odeslal, ale ještě není publikovaný.
Balíček symbolů (snupkg) je neplatný (viz omezení balíčku symbolů).

Parametry požadavku

Název	V	Typ	Požaduje se	Notes
X-NuGet-ApiKey	Hlavička	string	ano	Například `X-NuGet-ApiKey: {USER_API_KEY}`

Klíč rozhraní API je neprůhledný řetězec, který uživatel získal ze zdroje balíčku a nakonfiguroval ho do klienta. Není určený žádný konkrétní formát řetězce, ale délka klíče rozhraní API by neměla překročit přiměřenou velikost pro hodnoty hlaviček HTTP.

Text požadavku

Text požadavku pro nabízené symboly je stejný jako text požadavku nabízené žádosti balíčku (viz nabízení a odstranění balíčku).

Response

Kód stavu	Význam
201	Balíček symbolů byl úspěšně vložen.
400	Zadaný balíček symbolů je neplatný.
401	Uživatel nemá oprávnění k provedení této akce.
404	Odpovídající balíček se zadaným ID a verzí neexistuje.
409	Balíček symbolů s poskytnutým ID a verzí se odeslal, ale ještě není k dispozici.
413	Balíček je příliš velký.

Sdílet prostřednictvím