Skip to content
GitmoapAPIBeta
Schema

AnchorView

An anchor with enough of its work item attached to show it beside the code, such as #412 Bug: retry loop double-charges beside lines 88–104.

Shape

  • issueAnchorIssueSummary or nulloptionalThe work item's number, type, title and status. Absent briefly after the work item is deleted, until its anchors are removed.
    • The AnchorIssueSummary schema
    • iidIssueId (integer · int64)
    • scope_idstringThe id of the group or repository the work item lives in.
    • scope_typeScopeTypegrouprepositoryWhether the work item lives in a group or a repository. With scope_id and iid it is the item's current address — which need not be the repository the anchor is in: an item that moves keeps its anchors where the code is.
    • status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe fixed category behind a status. A status also has a name, which the team owns and may rename freely; the category is the part the platform reasons about. A team can call a status "Ready for QA" and the platform still knows it is in_review — so a board can place it in a column, a merge can move it, and a progress rollup can count it as not done.
    • status_idStatusId (string)
    • titleIssueTitle (string)
    • uidIssueUid (string · uuid)
    • work_item_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.

Example

Synthesized example
{
"issue": {
"iid": 36,
"scope_id": "5798db78-02d0-4c53-915a-4aab01a793c2",
"scope_type": "group",
"status_category": "triage",
"status_id": "21253b2c-0ad9-4ec6-84c6-97f4fecf67a2",
"title": "Draw the region map from operation density",
"uid": "694d4261-3db4-4915-a085-7b49e524a99a",
"work_item_type": "epic"
}
}

Graph

Used inside

No schema contains this one.

Used by