Releases

Description of the JSON object structure describing a release

Field	Type	Description
`id`	String	Release ID
`title`	String	Release title
`projectId`	String	Project ID
`authorId`	String	ID of the author of the last change
`description`	String	Release description
`tagName`	String	Tag name
`commitId`	String	Commit ID where the tag was created
`createdAt`	Date	Creation date
`updatedAt`	Date	Last update date
`attachmentFiles`	Array	Attached files
`preRelease`	Boolean	Pre-release `true` or not `false`

Description of the JSON object structure describing files attached to a release

Field	Type	Description
`name`	String	File name
`link`	String	File link
`size`	Integer	File size in bytes
`hashMd5`	String	Hash in hashMd5 format
`hashSha1`	String	Hash in Sha1 format
`hashSha256`	String	Hash in Sha256 format
`hashSha512`	String	Hash in Sha512 format

Method to get a list of releases

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

The request returns a list of releases, with the ability to configure number of objects per page

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias

Responses

STATUS 200 example JSON:

Example response

    
{
    "_embedded": {
        "releaseTagModelList": [
            {
                "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
                "title": "Title",
                "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
                "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
                "description": "Description",
                "tagName": "2.14.5",
                "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
                "createdAt": "2024-05-17T09:59:30.635513Z",
                "updatedAt": "2024-05-17T09:59:30.635515Z",
                "attachmentFiles":[
                    {
                        "name": "file.zip",
                        "uuid": "8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
                        "link": "https://gitflic.ru/project/user/test_project/release/d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680/file/8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
                        "size": 158267,
                        "hashMd5": "fff118534ecd753fc31ffh8ccb48e4c4",
                        "hashSha1": "d3b911c9ccdffc0de2c5ge8ae4907aa5ef00aa86",
                        "hashSha256": "33645ddcc7d5add5df70d27e59cef069d52887d6f3d41eec104eda3d1e7221b7",
                        "hashSha512": "261c9efed1f692f16127r6c02c045ae3779da7c7cf8c8f20ef81f9988e7f6b4414630cc2020011bcfe2aab2372d4cb7ded9985433cd68da42e571b83526c48c6"
                    }
                ],
                "preRelease": true
            },
            {
                "id": "abd2dd36-aaaa-aaaa-aaaa-f5912049a768",
                "title": "New Release",
                "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
                "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
                "description": "New some description",
                "tagName": "6.8.3",
                "commitId": "1b9eda1f6277f9aaaaaaaaaaaaff73fcf658ac16",
                "createdAt": "2024-05-17T11:12:21.954598Z",
                "updatedAt": "2024-05-17T11:12:21.954600Z",
                "attachmentFiles":[
                    {
                        "name": "test.zip",
                        "uuid": "8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
                        "link": "https://gitflic.ru/project/user/test_project/release/60b1530c-aaaa-aaaa-aaaa-05b3976cfe3d/file/8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
                        "size": 567865,
                        "hashMd5": "fff11853decd7w3fc31fbd8ccb48e4c4",
                        "hashSha1": "d3b911d9ccdffc0de2c57e8ae4w07aa5ef00aa86",
                        "hashSha256": "33645ddcc7d5add5d770427e59cefd69d52887d6f3d41eec104eda3d1e7221b7",
                        "hashSha512": "261c9efed1f692f1612e26c02c045ae3779da7c7cf8c8e20efd1f9988e7f6b4414230cc2020011bcfe2aab2342d4cb7ded9995433cd68da42e571b83526c48c6"
                    }
                ],
                "preRelease": false
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to get a release by uuid

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

The request returns a release by UUID.

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`releaseUuid`	String	Release ID

Responses

STATUS 200 example JSON:

Example response

    
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Title",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Description",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles":[
        {
            "name": "file.zip",
            "uuid": "8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "link": "https://gitflic.ru/project/user/test_project/release/d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680/file/8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "size": 158267,
            "hashMd5": "fff118534ecd753fc31ffh8ccb48e4c4",
            "hashSha1": "d3b911c9ccdffc0de2c5ge8ae4907aa5ef00aa86",
            "hashSha256": "33645ddcc7d5add5df70d27e59cef069d52887d6f3d41eec104eda3d1e7221b7",
            "hashSha512": "261c9efed1f692f16127r6c02c045ae3779da7c7cf8c8f20ef81f9988e7f6b4414630cc2020011bcfe2aab2372d4cb7ded9985433cd68da42e571b83526c48c6"
        }
    ],
    "preRelease": true
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to get the latest release

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

The request returns the latest release

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias

Responses

STATUS 200 example JSON:

Example response

    
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Title",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Description",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles":[
        {
            "name": "file.zip",
            "uuid": "8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "link": "https://gitflic.ru/project/user/test_project/release/d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680/file/8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "size": 158267,
            "hashMd5": "fff118534ecd753fc31ffh8ccb48e4c4",
            "hashSha1": "d3b911c9ccdffc0de2c5ge8ae4907aa5ef00aa86",
            "hashSha256": "33645ddcc7d5add5df70d27e59cef069d52887d6f3d41eec104eda3d1e7221b7",
            "hashSha512": "261c9efed1f692f16127r6c02c045ae3779da7c7cf8c8f20ef81f9988e7f6b4414630cc2020011bcfe2aab2372d4cb7ded9985433cd68da42e571b83526c48c6"
        }
    ],
    "preRelease": true
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to create a new release

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

The request creates and returns a new release

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias

Request

Supported format: JSON

POST request body structure:

Parameter	Description
`title`	Release title
`description`	Release description
`tagName`	Tag name
`preRelease`	Pre-release `true` or not `false`

Example JSON object

{
    "title": "Title",
    "description": "Description",
    "tagName": "2.14.5",
    "preRelease": true
}

Responses

STATUS 200 example JSON:

Example response

    
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Title",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Description",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles": null,
    "preRelease": true
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to edit release information

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

Edit release information by ID.

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`releaseUuid`	String	Release ID

Request

Supported format: JSON

POST request body structure:

Parameter	Description
`title`	Release title
`description`	Release description
`tagName`	Tag
`preRelease`	Pre-release `true` or not `false`

Example JSON object

{
    "title": "Title",
    "description": "Description",
    "tagName": "2.14.5",
    "preRelease": true
}

Responses

STATUS 200 example JSON:

Example response

    
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Title",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Description",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles":[
        {
            "name": "file.zip",
            "uuid": "54fe8947-aaaa-aaaa-aaaa-de2212f3253c",
            "link": "https://gitflic.ru/project/user/test_project/release/d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680/file/8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "size": 158267,
            "hashMd5": "fff118534ecd753fc31ffh8ccb48e4c4",
            "hashSha1": "d3b911c9ccdffc0de2c5ge8ae4907aa5ef00aa86",
            "hashSha256": "33645ddcc7d5add5df70d27e59cef069d52887d6f3d41eec104eda3d1e7221b7",
            "hashSha512": "261c9efed1f692f16127r6c02c045ae3779da7c7cf8c8f20ef81f9988e7f6b4414630cc2020011bcfe2aab2372d4cb7ded9985433cd68da42e571b83526c48c6"
        }
    ],
    "preRelease": true
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to add a file to a release

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

Upload new files to a release using multipart request

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`releaseUuid`	String	Release ID

Request

Supported format: multipart/form-data

Key	Type
`files`	file

Responses

STATUS 200 - Successfully added:

Example response

    
{
    "id": "da44fbf3-aaaa-aaaa-aaaa-1df9cc3c1598",
    "title": "Release1",
    "projectId": "f239feb2-aaaa-aaaa-aaaa-21617502b1cf",
    "authorId": "fbc3d462-aaaa-aaaa-aaaa-6990c978d786",
    "description": "some sssss description",
    "tagName": "tag-aaaa",
    "commitId": "b3fff4ead6c0fc31aaaa62018934974af39b5bcb",
    "createdAt": "2022-05-06T14:30:27.939457Z",
    "updatedAt": "2022-05-06T14:30:27.939468Z",
    "attachmentFiles": [
        {
            "name": "csv-parser-1.1.zip",
            "uuid": "ad70c088-aaaa-aaaa-aaaa-a60735f02f82",
            "link": "https://gitflic.ru/project/user/project/release/d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680/file/ad70c088-aaaa-aaaa-aaaa-a60735f02f82",
            "size": 15030,
            "hashMd5": "0a1587c7f5be28b7dcd5db57305ce015",
            "hashSha1": "ba3fbdcdecb6ab154414f8b9f8b3463e41b0ceef",
            "hashSha256": "c29c91beade7d9aec6eeb0881adb1a503ef9486ff635e45a3b8b3e6ec02cb817",
            "hashSha512": "5dfb6aa37213dcd7a4d61930e0f012d1f6fe208471cff6cb6cdce0501cb11ac61af047ef692e314f5b83e866137d36215fe587561778078a69225752d51fccd4"
        }
    ],
    "preRelease": false
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to download a file from a release

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

The request downloads a file attached to a release

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`releaseUuid`	String	Release ID
`fileUuid`	String	File ID

Responses

Supported format: application/octet-stream

STATUS 200 - File was sent

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to delete files from a release

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

The request deletes files from a release, the request body accepts an array of strings containing the id of files to delete.

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`releaseUuid`	String	Release UUID

Request

Supported format: application/json

DELETE request body structure:

[
    "69ce0056-aaaa-aaaa-aaaa-f0d02969a891",
    "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82"
]

Responses

STATUS 200 - Successfully deleted:

Example response

    
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Title",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Description",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles": [],
    "preRelease": true
}

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Method to delete a release

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

The request deletes a release

Path variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`releaseUuid`	String	Release ID

Responses

STATUS 200 - Successfully deleted.

STATUS 403 - No access rights.

STATUS 404 - Data not found.

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.