Теги

Описание структуры JSON-объекта, описывающего тег

Поле Тип Описание
name String Имя тега
fullName String Полное имя тега
objectId String ID объекта (для легковесных тегов совпадает с хэшом коммита)
shortMessage String Короткое сообщение (отсутствует для легковесных тегов)
fullMessage String Полное сообщение (отсутствует для легковесных тегов)
commitId String Хэш коммита на который ссылается тег
personIdent Объект personIdent Информация об авторе тега
lightWeight Boolean Легковесный тег true или аннотированный false

Описание структуры JSON-объекта, описывающего PersonIdent

Поле Тип Описание
name String Имя автора
avatart String Аватар автора
emailAddress String Email адрес
when DateTime Время создания тега

Метод для получения тегов проекта

GET /project/{ownerAlias}/{projectAlias}/tag

Запрос возвращает массив тегов, есть возможность настройки количества отображаемых объектов на странице

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "tagList": [
           {
                "name": "3.2.1",
                "fullName": "refs/tags/3.2.1",
                "objectId": "1a4cca6e2a5badaaaaaaaaaaaaf34aeeda3b4312",
                "shortMessage": "",
                "fullMessage": "",
                "commitId": "334894f08068f3aaaaaaaaaaaa6c4d11ab291901",
                "personIdent": {
                    "name": "user",
                    "avatar": "/static/image/avatar.jpg",
                    "emailAddress": "user@email.ru",
                    "when": "2024-05-14T08:57:19Z"
                },
                "lightWeight": false
            },
            {
                "name": "v1.4",
                "fullName": "refs/tags/v1.4",
                "objectId": "767824e6b49d65aaaaaaaaaaaad4d6b38667242e",
                "shortMessage": "",
                "fullMessage": "",
                "commitId": "b7a6c142f2a9b5aaaaaaaaaaaa4d7dd4f314f328",
                "personIdent": {
                   "name": "user",
                   "avatar": "/static/image/avatar.jpg",
                   "emailAddress": "user@email.ru",
                   "when": "2022-04-26T13:44:45Z"
                },
                "lightWeight": false
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения информации по тегу

GET /project/{ownerAlias}/{projectAlias}/tag/{tagName}

Запрос возвращает тег

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта
tagName String Имя тега

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "name": "3.2.1",
    "fullName": "refs/tags/3.2.1",
    "objectId": "1a4cca6e2a5badaaaaaaaaaaaaf34aeeda3b4312",
    "shortMessage": "",
    "fullMessage": "",
    "commitId": "334894f08068f3aaaaaaaaaaaa6c4d11ab291901",
    "personIdent": {
        "name": "user",
        "avatar": "/static/image/avatar.jpg",
        "emailAddress": "user@email.ru",
        "when": "2024-05-14T08:57:19Z"
    },
    "lightWeight": false
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для создания тега

POST /project/{ownerAlias}/{projectAlias}/tag/create

Запрос создает тег и возвращает информацию о нем. Тег можно создать на ветку или на коммит.

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта

Request

Поддерживаемый формат json

Структура тела POST-запроса:

Переменная JSON Тип Описание
tagName String Название тега
brachName String Название ветки проекта
commitId String Хэш коммита
message String Описание тега

Пример JSON объекта

{
    "tagName": "3.2.1",
    "commitId": "334894f08068f3aaaaaaaaaaaa6c4d11ab291901",
    "message": "Пример сообщения",
}

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "name": "3.2.1",
    "fullName": "refs/tags/3.2.1",
    "objectId": "1a4cca6e2a5badaaaaaaaaaaaaf34aeeda3b4312",
    "shortMessage": "",
    "fullMessage": "",
    "commitId": "334894f08068f3aaaaaaaaaaaa6c4d11ab291901",
    "personIdent": {
        "name": "user",
        "avatar": "/static/image/avatar.jpg",
        "emailAddress": "user@email.ru",
        "when": "2024-05-14T08:57:19Z"
    },
    "lightWeight": false
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Навигация