Пакеты push-символов
Можно отправлять пакеты символов (snupkg) с помощью API NuGet версии 3.
Эти операции основаны на ресурсеSymbolPackagePublish
, найденном в индексе службы.
Управление версиями
Используется следующее @type
значение:
Значение @type | Примечания. |
---|---|
SymbolPackagePublish/4.9.0 | Начальный выпуск |
Базовый URL-адрес
Базовый URL-адрес для следующих API — это значение @id
свойства SymbolPackagePublish/4.9.0
ресурса в индексе службы источника пакета. В документации ниже используется URL-адрес nuget.org. Рассмотрим https://www.nuget.org/api/v2/symbolpackage
как заполнитель для @id
значения, найденного в индексе службы.
Методы HTTP
Метод PUT
HTTP поддерживается этим ресурсом.
Отправка пакета символов
nuget.org поддерживает отправку новых пакетов символов (snupkg) с помощью следующего API.
PUT https://www.nuget.org/api/v2/symbolpackage
Пакеты символов с одинаковым идентификатором и версией можно отправлять несколько раз. Пакет символов будет отклонен в следующих случаях.
- Пакет с тем же идентификатором и версией не существует.
- Пакет символов с тем же идентификатором и версией был отправлен, но еще не опубликован.
- Пакет символов (snupkg) недопустим (см. ограничения пакета символов).
Параметры запроса
Имя. | In | Тип | Обязательное поле | Примечания. |
---|---|---|---|---|
X-NuGet-ApiKey | Верхний колонтитул | строка | yes | Например: X-NuGet-ApiKey: {USER_API_KEY} |
Ключ API — это непрозрачная строка, полученная из источника пакета пользователем и настроенная в клиенте. Не требуется конкретный формат строки, но длина ключа API не должна превышать разумный размер для значений заголовков HTTP.
Текст запроса
Текст запроса для отправки символов совпадает с текстом запроса на отправку пакета (см . отправку и удаление пакета).
Response
Код состояния | Значение |
---|---|
201 | Пакет символов успешно отправлен. |
400 | Предоставленный пакет символов недопустим. |
401 | Пользователь не авторизован для выполнения этого действия. |
404 | Соответствующий пакет с указанным идентификатором и версией не существует. |
409 | Пакет символов с предоставленным идентификатором и версией был отправлен, но он еще недоступен. |
413 | Пакет слишком велик. |