Update branch status check - Veryfront

updateBranchStatusCheck(branchId: ID!, checkName: String!, input: UpdateBranchStatusCheckInput!): BranchStatusCheck!

Requires project.files.write.

Arguments

Argument	Type	Required	Description
`branchId`	`ID!`	Yes	Branch the check reports on. A missing branch and one the caller cannot read are both not found.
`checkName`	`String!`	Yes	Check name; the key of the check on its branch.
`input`	`UpdateBranchStatusCheckInput!`	Yes

Input fields

input

UpdateBranchStatusCheckInput

Field	Type	Required	Description
`status`	`StatusCheckStatus!`	Yes	State to report.
`description`	`String`	No	Description of the result, at most 1000 characters.
`externalUrl`	`String`	No	Link to the external result; a URL of at most 2000 characters.

Response

Returns BranchStatusCheck!. Open the type for its fields and nested types.

Field	Type
`id`	`ID!`
`branchId`	`ID!`
`checkName`	`String!`
`status`	`StatusCheckStatus!`
`description`	`String`
`externalUrl`	`String`
`startedAt`	`String`
`completedAt`	`String`

All fields of BranchStatusCheck. Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation UpdateBranchStatusCheck($branchId: ID!, $checkName: String!, $input: UpdateBranchStatusCheckInput!) {
  updateBranchStatusCheck(branchId: $branchId, checkName: $checkName, input: $input) {
    id
    status
    createdAt
    updatedAt
    branchId
  }
}

{
  "branchId": "00000000-0000-4000-8000-000000000001",
  "checkName": "example",
  "input": {
    "status": "pending"
  }
}