Product
Search Results

Annotations

List annotations

Get a list of annotations.

GET /api/v1/results/{id}/tests/{seq}/annotations

Response 200 OK

{
    "timestamp": "2016-04-18T10:29:23.248104495-04:00",
    "data": [
        {
            "line": "4",
            "comment": "first comment"
        },
        {
            "line": "14",
            "comment": "second comment"
        },
        {
            "line": "23",
            "comment": "third comment"
        }
    ]
}

Get an annotation

Get an annotation.

GET /api/v1/results/{id}/tests/{seq}/annotations/{line}

Response 200 OK

{
    "timestamp": "2016-04-18T10:30:11.327055636-04:00",
    "data": {
        "id": "20160415113526",
        "seq": "1",
        "line": "23",
        "comment": "third comment"
    }
}

Response 404 Not Found

{
    "error": "no such annotation"
}

Create or edit an annotation

Create or edit an annotation.

PATCH /api/v1/results/{id}/tests/{seq}/annotations/{line}

Example

PATCH /api/v1/results/20160415113526/tests/1/annotations/19/

{
    "comment": "foo bar baz"
}

Response 200 OK

{
    "timestamp": "2016-04-18T10:31:06.212574153-04:00",
    "data": {
        "id": "20160415113526",
        "seq": "1",
        "line": "19",
        "comment": "foo bar baz"
    }
}

Delete an annotation

Delete an annotation.

DELETE /api/v1/results/{id}/tests/{seq}/annotations/{line}

Response 204 No Content