GitFlic API

Релизы

Описание структуры JSON-объекта, описывающего релиз
Поле Тип Описание
id String Айди релиза
title String Название релиза
projectId String Короткое название коммита
authorId String Айди автора последнего изменения релиза
description String Описание релиза
tagName String Название тэга
createdAt Date Дата создания
updatedAt Date Дата редактирования
attachmentFiles Array Прикрепленные [файлы]
preRelease Boolean Пререлиз
Описание структуры JSON-объекта, описывающего прикрепленные к релизу файлов
Поле Тип Описание
name String Название файла
link String Ссылка на файл

GET /project/{userAlias}/{projectAlias}/release

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

Запрос Описание
GET /project/{ownerAlias}/{projectAlias}/release Информация о релизе
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "releaseTagModelList": [
            {
                "id": "fa464a3f-39c3-4f52-8d6d-99ab2a8c521a",
                "title": "some release tittle",
                "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
                "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
                "description": "some sssss description",
                "tagName": "someTag",
                "commitId": "c899b58c03ce4c56d4630c13e2e09dce1188e33e",
                "createdAt": "2022-05-06T12:48:53.408168Z",
                "updatedAt": "2022-05-06T12:48:53.408174Z",
                "attachmentFiles": [
                    {
                        "name": "filter.zip",
                        "link": "localhost:8080/rest-api/project/db131/test/release/fa464a3f-39c3-4f52-8d6d-99ab2a8c521a/file/filter.zip"
                    }
                ],
                "preRelease": false
            },
            {
                "id": "dd44fbf1-720c-413b-8e6c-1df9cc3c1598",
                "title": "some release tittle 2",
                "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
                "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
                "description": "some description",
                "tagName": "votTak",
                "commitId": "b3fff4ead6c0fc31cfdd62018934974af39b5bcb",
                "createdAt": "2022-05-06T14:30:27.939457Z",
                "updatedAt": "2022-05-06T14:30:27.939468Z",
                "attachmentFiles": [],
                "preRelease": false
            },
            {
                "id": "da033b6f-47ae-4b06-b3cc-7fdcfe81358e",
                "title": "First release",
                "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
                "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
                "description": "some description",
                "tagName": "vot2Tak",
                "commitId": "b3fff4ead6c0fc31cfdd62018934974af39b5bcb",
                "createdAt": "2022-05-06T14:33:05.240199Z",
                "updatedAt": "2022-05-06T14:33:05.240211Z",
                "attachmentFiles": [],
                "preRelease": false
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 3,
        "totalPages": 1,
        "number": 0
    }
}


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

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

GET /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}

Запрос возвращает релиз по айди.

Запрос Описание
GET /project/{ownerAlias}/{projectAlias}/release/{releaseUuid} Информация о релизе
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта
releaseUuid String Айди прелиза

Responses

STATUS 200 пример JSON:

Пример ответа 
    
    {
        "id": "fa464a3f-39c3-4f52-8d6d-99ab2a8c521a",
        "title": "some release tittle",
        "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
        "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
        "description": "some sssss description",
        "tagName": "someTag",
        "commitId": "c899b58c03ce4c56d4630c13e2e09dce1188e33e",
        "createdAt": "2022-05-06T12:48:53.408168Z",
        "updatedAt": "2022-05-06T12:48:53.408174Z",
        "attachmentFiles": [
            {
                "name": "filter.zip",
                "link": "localhost:8080/rest-api/project/db131/test/release/fa464a3f-39c3-4f52-8d6d-99ab2a8c521a/file/filter.zip"
            }
        ],
        "preRelease": false
    }


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

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

PUT /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}

Редактирование информации о релизе по айди.

Запрос Описание
PUT /project/{ownerAlias}/{projectAlias}/release/{releaseUuid} Редактирование информации

Request

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

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

    
{
    "title": "title",
    "description": "some description",
    "tagName": "v2",
    "preRelease": false
}
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта
releaseUuid String Айди релиза

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "id": "fa464a3f-39c3-4f52-8d6d-99ab2a8c521a",
    "title": "title",
    "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
    "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
    "description": "some description",
    "tagName": "v2",
    "commitId": "c899b58c03ce4c56d4630c13e2e09dce1188e33e",
    "createdAt": "2022-05-06T12:48:53.408168Z",
    "updatedAt": "2022-05-11T13:11:34.934579Z",
    "attachmentFiles": [
        {
            "name": "filter.zip",
            "link": "localhost:8080/rest-api/project/dbi471/webhooks-test/release/fa464a3f-39c3-4f52-8d6d-99ab2a8c521a/file/filter.zip"
        }
    ],
    "preRelease": false
}


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

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

POST /project/{ownerAlias}/{projectAlias}/release

Создание нового релиза

Запрос Описание
POST /project/{ownerAlias}/{projectAlias}/release Создание нового релиза
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта

Request

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

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

    
{
    "title": "New Release",
    "description": "New some description",
    "tagName": "v24",
    "preRelease": false
}

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "id": "b9a6a3f-39c3-4f52-8d6d-9dab2a8c521a",
    "title": "New Release",
    "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
    "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
    "description": "New some description",
    "tagName": "v24",
    "commitId": "c899b58c03ce4c56d4630c13e2e09dce1188e33e",
    "createdAt": "2022-05-11T12:48:53.408168Z",
    "updatedAt": "2022-05-11T12:48:53.408168Z",
    "attachmentFiles": []
    "preRelease": false
}


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

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

DELETE /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}

Удаление релиза

Запрос Описание
DELETE /project/{ownerAlias}/{projectAlias}/release/{releaseUuid} Удаление релиза
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта
releaseUuid String Айди релиза

Responses

STATUS 200 - Удаление прошло успешно.

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

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

GET /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}/file/{fileName}

Скачать файл из релиза

Запрос Описание
GET /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}/file/{fileName} Получение файла из релиза по имени файла
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта
releaseUuid String Айди релиза
fileName String Название файла

Responses

Поддерживаемый формат: application/octet-stream

STATUS 200 - Файл был отдан

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

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

POST /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}/file

Загрузка новых файлов к релизу с помощью multipart request

Запрос Описание
POST /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}/file Добавление файлов к релизу
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта
releaseUuid String Айди релиза

Request Поддерживаемый формат: multipart/form-data

Ключ Тип
files file

Responses

STATUS 200 - Добавление прошло успешно:

Пример ответа 
    
{
    "id": "da44fbf3-720c-413b-8e6c-1df9cc3c1598",
    "title": "Release1",
    "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
    "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
    "description": "some sssss description",
    "tagName": "votTak",
    "commitId": "b3fff4ead6c0fc31cfdd62018934974af39b5bcb",
    "createdAt": "2022-05-06T14:30:27.939457Z",
    "updatedAt": "2022-05-06T14:30:27.939468Z",
    "attachmentFiles": [
        {
            "name": "csv-parser-1.1.zip",
            "link": "localhost:8080/rest-api/project/dbi471/webhooks-test/release/dd44fbf1-720c-413b-8e6c-1df9cc3c1598/file/csv-parser-1.1.zip"
        }
    ],
    "preRelease": false
}


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

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

DELETE /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}/file

Удаление файлов из релиза, в теле запроса принимается массив строк названия файлов для удаления.

Запрос Описание
DELETE /project/{ownerAlias}/{projectAlias}/release/{releaseUuid}/file Удаление файлов из релиза
Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца
projectAlias String Псевдоним проекта
releaseUuid String Айди релиза

Request

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

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

    
 [
    "releaseFile1.zip",
    "releaseFile2.zip"
 ]

Responses

STATUS 200 - Удаление прошло успешно:

Пример ответа 
    
{
    "id": "da44fbf3-720c-413b-8e6c-1df9cc3c1598",
    "title": "Релиз1",
    "projectId": "f239feb2-ded6-4998-9730-21617502b1cf",
    "authorId": "fbc3d462-a2e4-42bf-a6ec-6990c978d786",
    "description": "Описание",
    "tagName": "v23",
    "commitId": "b3fff4ead6c0fc31cfdd62018934974af39b5bcb",
    "createdAt": "2022-05-06T14:30:27.939457Z",
    "updatedAt": "2022-05-06T14:30:27.939468Z",
    "attachmentFiles": [
        {
            "name": "csv-parser-1.1.zip",
            "link": "localhost:8080/rest-api/project/dbi471/webhooks-test/release/dd44fbf1-720c-413b-8e6c-1df9cc3c1598/file/csv-parser-1.1.zip"
        }
    ],
    "preRelease": false
}

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

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

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

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

Описание структуры прикрепленных к релизу файлов

Получить все релизы

Получить информацию по конкретному релизу

Редактирование релиза

Создание нового релиза

Удаление релиза

Скачать файл релиза

Добавление файлов к релизу

Удаление файлов из релиза

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