API Documentation

Please note that the API is not stable, and may change without notice.

List Commits

Endpoint:

• HTTP Method: GET
• URL: /api/commits

Description:

This endpoint retrieves a list of the most recent commits. It returns an array of commit objects, each containing information about the commit, such as SHA, branch, creation date, and type coverage.

Request Parameters:

None

Response:

• Status Code: 200 (OK)
• Content Type: JSON
• Response Body Example:

[
    {
        "sha": "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d",
        "branch": "master",
        "created_at": "2023-11-08 12:34:56",
        "type_coverage": "99.60"
    },
    {
        "sha": "7c211433f02071597741e6ff5a8ea34789abbf43",
        "branch": "feature/example",
        "created_at": "2023-11-07 14:22:10",
        "type_coverage": "100.00"
    }
]

Please note that this is limited to the last 25 commits for unauthenticated users. Need more? Please contact us.

Show Commit Details

Endpoint:

• HTTP Method: GET
• URL: /api/commits/{commit}

Description:

This endpoint retrieves details of a specific commit identified by its unique sha identifier. It returns information about the specified commit, including SHA, branch, creation date, and type coverage.

Request Parameters:

• {commit}: The unique identifier of the commit.

Response:

• Status Code: 200 (OK)
• Content Type: JSON
• Response Body Example:

{
    "sha": "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d",
    "branch": "master",
    "created_at": "2023-11-08 12:34:56",
    "type_coverage": "100.00"
}