API ReferenceContext Repository
Get a gap's journal
Returns every change to the gap, oldest first: the version it made, who made it, whether that was a person or an automation, and what changed.
GET /context/v1/gaps/{gap_id}/journal
Returns every change to the gap, oldest first: the version it made, who made it, whether that was a person or an automation, and what changed. A retirement entry names the assets that cover the debt and the evidence behind it.
Requires the context:read scope.
Parameters
| Parameter | Location | Required | Description |
|---|---|---|---|
gap_id | path | yes | The gap's id. |
Responses
| Status | Meaning |
|---|---|
200 | The request succeeded. |
401 | The token is missing, expired or invalid. |
403 | The token does not carry the scope this operation requires. |
404 | No such project, or the token belongs to a different project. |
422 | The request was not valid: a parameter or the body failed validation. |
The 200 response body:
| Field | Type | Required | Description |
|---|---|---|---|
gap_id | string | yes | The gap's id. |
journal | array of GapJournalRecord | yes | Every change to the gap. |
Shapes
The named shapes used above.
GapJournalRecord
One change to a gap.
| Field | Type | Required | Description |
|---|---|---|---|
actor_kind | string | yes | person or automation. |
author | string | yes | Who made it. |
change_kind | string | yes | What kind of change it was: created, content_updated or deleted. |
closed_release | integer or null | no | The release this closure was recorded under, the one its covered_by assets are read at. Empty for an entry that is not a closure. |
covered_by | array of string | yes | On a retirement, the assets the closure named as covering the debt (possibly none). |
rationale | string | yes | Why, when the author said. |
summary | string | yes | What changed, in a line. |
timestamp | string | yes | When it happened. |
version | integer | yes | The version the change made. |
Example
curl -sS "$API_URL/context/v1/gaps/$GAP_ID/journal" \
-H "Authorization: Bearer $TOKEN"