GitFlic API

Теги

Описание структуры JSON-объекта, описывающего тег
Поле Тип Описание
name String Имя тега
fullName String Полное имя тега
objectId String Айди объекта (для легковесных тегов совпадает с хэшом коммита)
shortMessage String Короткое сообщение (отсутсвует для легковесных тегов)
fullMessage String Полное сообщение (отсутсвует для легковесных тегов)
commitId String Хэш коммита на который ссылается тег.
personIdent Объект personIdent Информация об авторе тега
lightWeight Boolean Легковесный тег (true) или аннотированный (false)
Описание структуры JSON-объекта, описывающего PersonIdent
Поле Тип Описание
name String Имя автора
avatart String Аватар автора
emailAddress String Email адрес
when DateTime Время создания тега

GET /rest-api/project/{ownerAlias}/{projectAlias}/tag

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

Запрос Описание
GET /rest-api/project/{ownerAlias}/{projectAlias}/tag/{tagName} Получение всех тегов проекта

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "tagList": [
            {
                "name": "v2",
                "fullName": "refs/tags/v2",
                "objectId": "38a51054ee1449c5b0c8222724b697b497bdf95a",
                "shortMessage": null,
                "fullMessage": null,
                "commitId": "38a51054ee1449c5b0c8222724b697b497bdf95a",
                "personIdent": null,
                "lightWeight": true
            },
            {
                "name": "v1.4",
                "fullName": "refs/tags/v1.4",
                "objectId": "767824e6b49d65127578c786bd68d6b38667242e",
                "shortMessage": "my version 1.4",
                "fullMessage": "my version 1.4\n",
                "commitId": "b7a6c142f2a9b575472c5b9112237dd4f314f328",
                "personIdent": {
                   "name": "Gitflic",
                   "avatar": "/static/image/avatar.jpg",
                   "emailAddress": "support@gitflic.ru",
                   "when": "2022-04-26T13:44:45Z"
                },
                "lightWeight": false
            },
            {
                "name": "tagv3",
                "fullName": "refs/tags/tagv3",
                "objectId": "9353f7a6ef5b0ef4fa26cce6de37b95c94961a04",
                "shortMessage": null,
                "fullMessage": null,
                "commitId": "9353f7a6ef5b0ef4fa26cce6de37b95c94961a04",
                "personIdent": null,
                "lightWeight": true
            },
            {
                "name": "test",
                "fullName": "refs/tags/test",
                "objectId": "c899b58c03ce4c56d4630c13e2e09dce1188e33e",
                "shortMessage": null,
                "fullMessage": null,
                "commitId": "c899b58c03ce4c56d4630c13e2e09dce1188e33e",
                "personIdent": null,
                "lightWeight": true
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 4,
        "totalPages": 1,
        "number": 0
    }
}


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

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

GET /rest-api/project/{ownerAlias}/{projectAlias}/tag/{tagName}

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

Запрос Описание
GET /rest-api/project/{ownerAlias}/{projectAlias}/tag/{tagName} Получение тега по имени

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "name": "v1.4",
    "fullName": "refs/tags/v1.4",
    "objectId": "767824e6b49d65127578c786bd68d6b38667242e",
    "shortMessage": "my version 1.4",
    "fullMessage": "my version 1.4\n",
    "commitId": "b7a6c142f2a9b575472c5b9112237dd4f314f328",
    "personIdent": {
        "name": "Gitflic",
        "avatar": "/static/image/avatar.jpg",
        "emailAddress": "support@gitflic.ru",
        "when": "2022-04-26T13:44:45Z"
    },
    "lightWeight": false
}


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

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

POST /rest-api/project/{ownerAlias}/{projectAlias}/tag/create

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

Запрос Описание
POST /rest-api/project/{ownerAlias}/{projectAlias}/tag/create создание тега
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта

Request

Поддерживаемый формат Content-type заголовок: application/json

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

Переменная JSON тела Тип Описание
tagName String Название тега
branchName String Название ветки, к последнему коммиту в которой будет прикреплен тег
message String Описание тега

Пример JSON тела

    
        {
                "tagName": "tagExampleName",
                "branchName": "master",
                "message": "example message"
        }


Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "name": "v1.4",
    "fullName": "refs/tags/v1.4",
    "objectId": "767824e6b49d65127578c786bd68d6b38667242e",
    "shortMessage": "my version 1.4",
    "fullMessage": "my version 1.4\n",
    "commitId": "b7a6c142f2a9b575472c5b9112237dd4f314f328",
    "personIdent": {
        "name": "Gitflic",
        "avatar": "/static/image/avatar.jpg",
        "emailAddress": "support@gitflic.ru",
        "when": "2022-04-26T13:44:45Z"
    },
    "lightWeight": false
}


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

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

В данной статье

Описание структуры тегов

Описание структуры PersonIdent

Получение всех тегов проекта

Получение тега по названию

Создание тега

Документация