プッシュ シンボル パッケージ
NuGet V3 API を使用してシンボル パッケージ (snupkg) をプッシュできます。
これらの操作は、サービス インデックス内にある SymbolPackagePublish リソースに基づいています。
バージョン管理
次の @type 値が使用されます。
| @type 値 | メモ |
|---|---|
| SymbolPackagePublish/4.9.0 | 初期リリース |
ベース URL
次の API のベース URL は、パッケージ ソースのサービス インデックスにある、SymbolPackagePublish/4.9.0 リソースの @id プロパティの値です。 以下のドキュメントでは、nuget.org の URL が使用されています。 https://www.nuget.org/api/v2/symbolpackage は、サービス インデックスに含まれる @id 値のプレースホルダーだと考えてください。
HTTP メソッド
このリソースでは、PUT HTTP メソッドをサポートしています。
シンボル パッケージのプッシュ
nuget.org では、新しいシンボル パッケージ形式 (snupkg) の、次の API を使用したプッシュがサポートされています。
PUT https://www.nuget.org/api/v2/symbolpackage
同じ ID とバージョンのシンボル パッケージは、複数回送信することができます。 次の場合、シンボル パッケージは拒否されます。
- 同じ ID とバージョンのパッケージが存在しない。
- 同じ ID とバージョンのシンボル パッケージがプッシュ済みで、まだ公開されていない。
- シンボル パッケージ (snupkg) が無効 (「シンボル パッケージの制約」を参照)。
要求パラメーター
| 名前 | / | タイプ | 必須 | メモ |
|---|---|---|---|---|
| X-NuGet-ApiKey | ヘッダー | string | はい | たとえば、X-NuGet-ApiKey: {USER_API_KEY} のように指定します。 |
API キーは、ユーザーによってパッケージ ソースから取得され、クライアントで構成された Opaque な文字列です。 特定の文字列形式は必須ではありませんが、API キーの長さは、HTTP ヘッダー値の妥当なサイズを超えないようにする必要があります。
要求本文
シンボル プッシュの要求本文は、パッケージ プッシュ要求の要求本文と同じです (「パッケージのプッシュと削除」を参照してください)。
回答
| 状態コード | 意味 |
|---|---|
| 201 | シンボル パッケージが正常にプッシュされました。 |
| 400 | 指定されたシンボル パッケージは無効です。 |
| 401 | ユーザーによる、このアクションの実行は承認されていません。 |
| 404 | 指定された ID とバージョンに対応するパッケージは存在しません。 |
| 409 | 指定された ID とバージョンを持つシンボル パッケージはプッシュ済みですが、まだ使用できません。 |
| 413 | パッケージが大きすぎます。 |