Методы пакетов уровня сервиса
Для работы данных методов необходимы права администратора сервиса
Метод получения всех пакетов сервиса
GET /registry/package
Запрос возвращает список пакетов сервиса, есть возможность настройки количества отображаемых объектов на странице
Responses
STATUS 200 пример JSON:
Пример ответа
{
"_embedded": {
"simplePackageInfoModelList": [
{
"id": "23920af6-aaaa-aaaa-aaaa-396811188f65",
"name": "Package",
"version": "1.0.0",
"groupId": "group",
"artifactId": "artefact](.. "type": "generic",
"ownerUuid": "",
"ownerType": "GLOBAL"
},
{
"id": "deb52e29-aaaa-aaaa-aaaa-737eac0eb8f7",
"name": "Example",
"version": "1.0.3",
"groupId": "example",
"artifactId": "example",
"type": "nuget",
"ownerUuid": "",
"ownerType": "GLOBAL"
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения пакета сервиса по UUID
GET /registry/package/{packageUuid}
Запрос возвращает информацию о пакете сервиса
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageUuid |
String | Идентификатор пакета |
Responses
STATUS 200 пример JSON:
Пример ответа
{
"id": "7eeda8b0-aaaa-aaaa-aaaa-bd1fed06bf95",
"name": "Package",
"version": "1.0.1",
"groupId": "Package",
"artifactId": "Package",
"type": "generic",
"ownerUuid": "",
"ownerType": "GLOBAL"
}
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения списка версий пакета сервиса
GET /registry/package/{packageUuid}/version-list
Запрос возвращает информацию о версиях пакета и их содержимом, есть возможность настройки количества отображаемых объектов на странице
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageUuid |
String | Идентификатор пакета |
Responses
STATUS 200 пример JSON:
Пример ответа
{
"_embedded": {
"simplePackageVersionModelList": [
{
"id": "fb97db0e-aaaa-aaaa-aaaa-9a95f4f36e9a",
"baseVersion": "1.2.3",
"version": "1.2.3",
"lowerVersion": "1.2.3",
"downloadCount": 12,
"languageVersion": null,
"packageUploadType": "MANUALLY",
"packageFiles": [
{
"id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
"name": "gitflic-helper",
"size": 631382,
"hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
"hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
"hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
"packageUploadType": "MANUALLY",
"createdAt": "2024-08-01T06:57:07.150295"
}
],
"internal": null
},
{
"id": "800cad33-aaaa-aaaa-aaaa-8ba5864b4914",
"baseVersion": "2.4.7",
"version": "2.4.7",
"lowerVersion": "2.4.7",
"downloadCount": 31,
"languageVersion": null,
"packageUploadType": "API",
"packageFiles": [
{
"id": "684068a6-aaaa-aaaa-aaaa-bebea0e2b46a",
"name": "gitflic.ssh",
"size": 4325,
"hashMd5": "d41d8cd98f00aaaaaaaa0998ecf8427e",
"hashSHA1": "da39a3ee5e6baaaaaaaaaaaaaaaa1890afd80709",
"hashSHA256": "e3b0c44298fcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa991b7852b855",
"packageUploadType": "API",
"createdAt": "2024-07-31T14:02:49.393146"
}
],
"internal": null
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения версии пакета сервиса
GET /registry/package/{packageUuid}/{packageVersion}
Запрос возвращает информацию о версии пакета и ее содержимом
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageUuid |
String | Идентификатор пакета |
packageVersion |
String | Версия пакета |
Responses
STATUS 200 пример JSON:
Пример ответа
{
"id": "fb97db0e-aaaa-aaaa-aaaa-9a95f4f36e9a",
"baseVersion": "1.2.3",
"version": "1.2.3",
"lowerVersion": "1.2.3",
"downloadCount": 12,
"languageVersion": null,
"packageUploadType": "MANUALLY",
"packageFiles": [
{
"id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
"name": "gitflic-helper",
"size": 631382,
"hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
"hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
"hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
"packageUploadType": "MANUALLY",
"createdAt": "2024-08-01T06:57:07.150295"
}
],
"internal": null
}
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения информации о содержимом пакета сервиса
GET /registry/package/{packageUuid}/package-file
Запрос возвращает информацию о содержимом разных версий пакета, есть возможность настройки количества отображаемых объектов на странице
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageUuid |
String | Идентификатор пакета |
Responses
STATUS 200 пример JSON:
Пример ответа
{
"_embedded": {
"simplePackageFileModelList": [
{
"id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
"name": "gitflic-helper",
"size": 631382,
"hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
"hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
"hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
"packageUploadType": "MANUALLY",
"createdAt": "2024-08-01T06:57:07.150295"
},
{
"id": "684068a6-aaaa-aaaa-aaaa-bebea0e2b46a",
"name": "gitflic.ssh",
"size": 4325,
"hashMd5": "d41d8cd98f00aaaaaaaa0998ecf8427e",
"hashSHA1": "da39a3ee5e6baaaaaaaaaaaaaaaa1890afd80709",
"hashSHA256": "e3b0c44298fcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa991b7852b855",
"packageUploadType": "API",
"createdAt": "2024-07-31T14:02:49.393146"
}
]
},
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета generic
GET /registry/package/generic/{packageName}/{packageVersion}/{fileName}
Запрос возвращает файл пакета generic
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета generic
PUT /registry/package/generic/{packageName}/{packageVersion}/{fileName}
Запрос загружает прикрепленный файл в указанную версию пакета generic. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета PyPI
GET /registry/package/pypi/{packageName}/{packageVersion}/{fileName}
Запрос возвращает файл пакета PyPi
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета PyPI
PUT /registry/package/pypi/{packageName}/{packageVersion}/{fileName}
Запрос загружает прикрепленный файл в указанную версию пакета PyPi. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета Maven
GET /registry/package/maven/{packageUuid}/{packageVersion}/{fileUuid}/download
Запрос возвращает файл пакета Maven
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageUuid |
String | Идентификатор пакета |
packageVersion |
String | Версия пакета |
fileUuid |
String | Идентификатор файла |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета Maven
PUT /registry/package/maven/{groupId}/{artifactId}/{version}/{fileName}
Запрос загружает прикрепленный файл в указанную версию пакета Maven. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
groupId |
String | Идентификатор группы |
artifactId |
String | Идентификатор артефакта |
version |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета NPM
В зависимости от наличия группы пакетов (scope) необходимо использовать один из перечисленных ниже методов:
Получение пакета, для которого не указана группа (scope):
GET /registry/package/npm/{packageName}/{packageVersion}/{fileName}
Получение пакета, для которого указана группа (scope):
GET /registry/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}
Запрос возвращает файл пакета NPM
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageScope |
String | Группа пакетов (scope) |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета NPM
В зависимости от наличия группы пакетов (scope) необходимо использовать один из перечисленных ниже методов:
Обновление пакета, для которого не указана группа (scope):
PUT /registry/package/npm/{packageName}/{packageVersion}/{fileName}
Обновление пакета, для которого указана группа (scope):
PUT /registry/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}
Запрос загружает прикрепленный файл в указанную версию пакета NPM. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
paсkageScope |
String | Область видимости |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета Composer
PUT /registry/package/composer/{packageVersion}
Запрос загружает прикрепленный файл в указанную версию пакета Composer. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageVersion |
String | Версия пакета |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета Composer
GET /registry/package/composer/{groupId}/{artifactId}/{packageVersion}
Запрос возвращает файл пакета Composer
| Переменная пути запроса | Тип | Описание |
|---|---|---|
groupId |
String | Идентификатор группы |
artifactId |
String | Идентификатор артефакта |
packageVersion |
String | Версия пакета |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета NuGet
PUT /registry/package/nuget
Запрос загружает прикрепленный файл в указанную версию пакета NuGet. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета NuGet
GET /registry/package/nuget/{packageName}/{packageVersion}
Запрос возвращает файл пакета NuGet
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageVersion |
String | Версия пакета |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета OneScript
PUT /registry/package/opm/{fileName}
Запрос загружает прикрепленный файл в указанную версию пакета OneScript. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
fileName |
String | Имя файла |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета OneScript
GET /registry/package/opm/{packageName}/{packageVersion}/{fileName}
Запрос возвращает файл пакета OneScript
| Переменная пути запроса | Тип | Описание |
|---|---|---|
packageName |
String | Имя пакета |
packageVersion |
String | Версия пакета |
fileName |
String | Имя файла |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод обновления содержимого пакета Cran
PUT /registry/package/cran/{languageVersion}/{fileName}
Запрос возвращает файл пакета Cran
| Переменная пути запроса | Тип | Описание |
|---|---|---|
languageVersion |
String | Версия языка |
fileName |
String | Имя файла |
Responses
STATUS 200 - Пакет загружен.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.
Метод получения содержимого пакета Cran
GET /registry/package/cran/{fileName}?languageVersion={languageVersion}&platform={platform}
Запрос загружает прикрепленный файл в указанную версию пакета Cran. С помощью данного метода можно создать новую версию пакета или пакет целиком, при условии указания не существующих данных.
| Переменная пути запроса | Тип | Описание |
|---|---|---|
fileName |
String | Имя файла |
languageVersion |
String | Версия языка |
platform |
String | Обязателен только для скачивания файлов в формате .tgz и .zip. Платформа, для которой создан пакет. Может принимать следующие значения: macosx, windows |
Responses
STATUS 200 - Содержимое пакета получено.
STATUS 403 - Нет прав для доступа.
STATUS 404 - Данные по запросу не найдены.