Shipeasy
APIOperations

Resolve or dismiss a finding

Set a finding's status — resolved (it was fixed; say how in reason), dismissed (it is not a problem; say why), or back to open. A finding that is real but…

Set a finding's status — resolved (it was fixed; say how in reason), dismissed (it is not a problem; say why), or back to open. A finding that is real but out of scope is not dismissed: promote it with trails promote-finding.

Safe for the restricted ops key.

Use case

The coding agent fixed a flagged issue, pushed, and resolves the finding with reason: "fixed in abc1234".

PATCH
/api/admin/trails/{handle}/findings/{findingId}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

handle*string

The trail's handle (T-12) or its id.

Match^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$
Length1 <= length <= 64
findingId*string

The finding id.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://shipeasy.ai/api/admin/trails/string/findings/string" \  -H "Content-Type: application/json" \  -d '{    "status": "resolved",    "reason": "fixed in abc1234"  }'
{
  "id": "string",
  "agentKey": "string",
  "headSha": "string",
  "severity": "high",
  "title": "string",
  "body": "string",
  "path": "string",
  "line": 0,
  "suggestion": "string",
  "status": "open",
  "stale": true,
  "statusReason": "string",
  "statusBy": "string",
  "promotedItem": {
    "id": "string",
    "number": 0,
    "type": "bug",
    "title": "string",
    "status": "open"
  },
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?