Skip to content
GitmoapAPIBeta
Schema

EffectiveIssueSettingsResponse

The work item settings in force for a repository, with every inherited and default value filled in.

Shape

  • anchor_drift_actionAnchorDriftActionflagcommentnoneWhat happens when an anchored region of code changes beyond recognition.
  • auto_close_on_verifiedbooleanWhether a work item closes as soon as it is verified. Defaults to false: passing criteria make an item verified, and merging the merge request that closes it makes it done.
  • auto_reopen_on_orphaned_closebooleanA closed item whose closing commit is in no branch any more reopens itself.
  • auto_reopen_on_regressionboolean
  • binding_change_resets_evidencebooleanReset a criterion's evidence when its binding changes. Default true.
  • blocked_by_blocks_closeboolean
  • close_on_commit_keywordboolean
  • closing_branchesarray of BranchPattern (string)Branch globs whose commits close work items, in addition to the default branch, which always does. Empty by default.
  • default_assignee_from_codeownersboolean
  • default_issue_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.
  • on_branch_createdAutoTransition
  • on_mr_closedAutoTransition
  • on_mr_mergedAutoTransition
  • on_mr_openedAutoTransition
  • override_group_settingsboolean
  • public_issue_filingboolean
  • require_verified_criteria_to_closeboolean
  • statusesarray of StatusDef
    • The StatusDef schema
    • categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe category this status belongs to. It cannot be changed after the status is created: to move work to a different category, add a status and archive this one.
    • namestring
    • status_idStatusId (string)
    • archivedbooleanoptional
    • colorLabelColor (string) or nulloptional
    • is_defaultbooleanoptionalThe status new issues land in. Exactly one status in a set carries it, and it must be open.
  • todo_ignore_pathsarray of stringPath globs never scanned for TODO comments. Defaults to the usual locations of vendored code.
  • todo_policyTodoPolicyignoreindexpromoteWhat a bare // TODO: in a push becomes.
  • todo_promote_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.
  • transitionsTransitionTable

Example

Synthesized example
{
"anchor_drift_action": "flag",
"auto_close_on_verified": false,
"auto_reopen_on_orphaned_close": false,
"auto_reopen_on_regression": false,
"binding_change_resets_evidence": false,
"blocked_by_blocks_close": false,
"close_on_commit_keyword": false,
"closing_branches": [
"closing-branches-db54",
"closing-branches-b64c"
],
"default_assignee_from_codeowners": false,
"default_issue_type": "epic",
"on_branch_created": "disabled",
"on_mr_closed": "disabled",
"on_mr_merged": "disabled",
"on_mr_opened": "disabled",
"override_group_settings": false,
"public_issue_filing": false,
"require_verified_criteria_to_close": false,
"statuses": [
{
"category": "triage",
"name": "payments-api",
"status_id": "8d6ea8f9-70bf-48aa-8bb5-47c4fdb586d4"
},
{
"category": "triage",
"name": "payments-api",
"status_id": "d7863efd-8428-4818-b418-63a298507fd4"
}
],
"todo_ignore_paths": [
"todo-ignore-paths-1a0a"
],
"todo_policy": "ignore",
"todo_promote_type": "epic",
"transitions": {
"table": {}
}
}

Graph

Used inside

No schema contains this one.

Used by

Sent by 0 operations

No operation takes it as a request body.