Skip to content

api-modules.md

Latest commit

 

History

History
123 lines (87 loc) · 1.76 KB

api-modules.md

File metadata and controls

123 lines (87 loc) · 1.76 KB

Modules Endpoints

Add Module

Add module.

Request

POST /v1/modules/${TEAM}/${PROJECT}/names/${NAME}

Parameters

Parameter Description
TEAM Team name.
PROJECT Project name.
NAME Module name.

Response

{
    "name": <string>
    "project": <string>
    "team": <string>
    "version": <int>
}

Download Module

Download module by version.

Request

GET /v1/modules/${TEAM}/${PROJECT}/names/${NAME}/versions/${VERSION}

Parameters

Parameter Description
TEAM Team name.
PROJECT Project name.
NAME Module name.
VERSION Module version.

Response

Data as a file.

Delete Module

Delete module by version.

Request

DELETE /v1/modules/${TEAM}/${PROJECT}/names/${NAME}/versions/${VERSION}

Parameters

Parameter Description
TEAM Team name.
PROJECT Project name.
NAME Module name.
VERSION Module version.

List Modules

List modules.

Request

GET /v1/modules/list

GET /v1/modules/${TEAM}/${PROJECT}/list

GET /v1/modules/${TEAM}/${PROJECT}/names/${NAME}/list

Parameters

Parameter Description
TEAM Team name.
PROJECT Project name.
NAME Module name.

Response

[
    {
        "created": <string>
        "id": <int>
        "name": <string>
        "project": <string>
        "team": <string>
        "updated": <string>
        "version": <int>
    }
]