Skip to content
GitmoapAPIBeta
Schema

ExplainedLimit

One limit that applied in an explanation.

Shape

  • atAccessScope
  • removedarray of stringPermissions the grants gave that this limit took away, by key.
  • ceilingRoleView or nulloptionalThe most the limit lets its subject hold. Absent when it allows nothing at all.
    • The RoleView schema
    • namestringThe role's display name: a built-in name such as Developer, or the custom role's name.
    • rankAccessLevelguestreporterdevelopermaintainerownerThe built-in rank the role counts as wherever a rank is compared, such as a protected branch's minimum.
    • builtinAccessLevelguestreporterdevelopermaintainerowneror nulloptionalSet when the role is built in.
    • customRoleId (string · uuid) or nulloptionalSet when the role is one the organization defined.

Example

Synthesized example
{
"at": {
"full_path": "acme/payments-api",
"id": "id-0314",
"type": "group"
},
"removed": [
"removed-9e0d"
],
"subject": "principal",
"ceiling": {
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "d458fc83-1801-44cc-b63c-d95137853741"
}
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.