mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-16 11:59:26 +01:00
## Thinking Path > - Paperclip helps people manage AI agents for work. > - The sidebar helps people return to recent tasks. > - Recent parents need foldable child tasks. > - Busy companies must not refresh every child group for unrelated work. > - Exact unread counts must preserve personal reads and task access. > - This pull request adds child groups and bounds their refresh work. > - People can scan subtasks without repeated background requests. ## Linked Issues or Issue Description **Subsystem affected** Task navigation in the standard and Classic sidebars. **Problem or motivation** Recent parent tasks did not show their subtasks. The first implementation refreshed every previously viewed group. One unrelated update caused 52 child-page requests and one summary request after viewing 50 groups. Exact child counts also repeated privacy and unread checks per child. **Proposed solution** Show direct subtasks with independent folding and ten-row pages. Refresh affected groups and summary batches. Stop offscreen reads. Bound child-request concurrency. Aggregate viewer facts once and preserve the existing inbox unread rule. **Roadmap alignment** This extends existing task navigation. The existing feature PR is reused for its performance repair. No new PR duplicates it. ## What Changed - Add shared parent groups to both sidebar layouts. Preserve Classic row actions and active-child visibility. - Keep unread state personal to each task. Folding and paging do not mark tasks read. Counts include readable children beyond ten. - Target live refreshes with authorized current and previous parent IDs. Reuse parent metadata from the narrow run-binding read. Resolve fallback lookups once per delivery batch. Keep the previous summary fallback for older servers. - Limit child requests to three at a time. Cancel active and queued reads when groups leave the viewport. - Discard extra cached pages on Show less and collapse. - Compute exact navigation counts in one SQL statement. Materialize readable candidate IDs once. Use indexed participation sources and conservative unread candidates before the shared inbox rule. - Skip recursive privacy walks for standalone open tasks without a project. Keep the recursive rule for all restricted or inherited shapes and all delegated principals. - Add request-count, cancellation, reparenting, read-receipt, inbox-parity and privacy regressions. Include a disposable PostgreSQL benchmark. - Update product and API documentation. Retain the production Storybook states. ## Verification - Published head: `4148861437c1b6b635479ad92509dbc71155a232`. Its tree matches local `04be9d66d481d9bcd1c4d6158acf063a1e65ac7e`: `a23533e93d3d155918f0254d296a7fd2f0c7c12f`. - Rebased on master `ca23330c69b1f2b25bdadfcbda68317db97deaef`. Remote publication preserves prior feature commits. - The request regression failed before the fix and passes after it. An unrelated event now sends zero child requests. Current servers also avoid the unrelated summary request. Old-server events keep one summary fallback. - A relevant update after Show less reads one page. Reparenting refreshes two affected groups. Offscreen reads stay at zero and resume once on return. Active and queued cancellation tests pass. - The same synthetic authenticated HTTP workload with 50,000 read children improved from 767 ms to 92.84 ms median. Five warm samples per case. The all-unread case improved from 463.85 to 351.65 ms. Untouched children improved from 208.01 to 131.09 ms. The old-receipt case improved from 799.70 to 245.80 ms. These local measurements are not a production capacity guarantee. - Focused PostgreSQL routes, inbox-parity, privacy and WebSocket tests passed: 38 tests. - All 325 affected UI tests passed. All 38 focused PostgreSQL, privacy and WebSocket tests passed. UI typecheck and low-memory server declaration checks passed. - All 41 Chromium Storybook checks passed. They cover 20 states in both themes and keyboard, folding, paging and unread behavior. They use production components with HTTP fixtures. - Both new review findings failed as regressions before their fixes and pass afterward. Explicit child reads include waiting external conversations. Deleting a child publishes a separate parent-authorized update without deleted-child content. Both review threads are resolved. - `pnpm verify --explain` returned exit 2 because product documentation requires broader CI. [The prior CI run](https://github.com/paperclipai/paperclip/actions/runs/43711489306) found type errors in the new test fixtures. The same errors failed locally. The fixture fix passes `node server/scripts/typecheck-layers.mjs --layer test-tree-0` and all 21 issue summary route tests. Production code is unchanged. That CI run then found a live-delivery read regression. The existing test failed locally with eight statements against its six-statement budget. A new PostgreSQL regression also found three parent lookups for two same-batch calls. Run delivery now reuses parent metadata from its narrow run-binding query. Fallback lookups resolve to one promise. Both regressions pass without increasing the budgets. All 74 targeted route, WebSocket and privacy tests pass. The affected below, above and test-tree-0 typecheck layers pass. [CI attempt 2](https://github.com/paperclipai/paperclip/actions/runs/43715541480/attempts/2) passes on the published head. All 62 check runs are terminal and clean: 57 succeeded, two were neutral and three were skipped. Typecheck, build, policy, all general and serialized server suites, E2E and the [final verify gate](https://github.com/paperclipai/paperclip/actions/runs/43715541480/job/132829783231) pass. The separate security status passes. Attempt 1's server shard 7/12 reached its 20-minute job limit without a test verdict. One retry of that job passed without a source change. [Greptile completed successfully on this head](https://github.com/paperclipai/paperclip/runs/132816163906) with a [5/5 score](https://github.com/paperclipai/paperclip/pull/21649#issuecomment-6883916606). All five review threads are resolved. The final CI gate is complete. - A full local Storybook build exceeded available memory while server typechecking ran. Browser verification uses the current-source development server. Rebuilding stale Runner and SDK declarations resolved the initial server check errors. The first browser attempt lacked Chromium; all checks passed after installation. - Reproduce the database measurements with `pnpm --filter @paperclipai/server exec tsx scripts/benchmark-sidebar-subtasks.ts`. - Extra local shard diagnosis ran 164 suites. Under this shell's `0077` creation mask, 157 suites passed and three had fixture permission or timing failures. Rerunning those three with `0022` resolved the permission failures. The remaining ten cases passed with one worker: two workspace cases and eight archive cases. The eight archive cases also passed on the pre-performance-fix revision, whose archive source is identical. The broad local shard is not claimed as one passing execution. The same-head CI retry supplies complete final CI coverage. - Nothing is merged or deployed. ## Risks - Exact counts still grow with the readable hierarchy and comment history. The change reduces repeated work; it does not cap or approximate counts. - A relevant summary batch can contain several recent parents. Older servers retain a broader summary fallback until upgraded. - Live delivery adds bounded, permission-checked parent lookups. Short delivery-window reuse limits repeated reads. - The authorization fast path applies only to open tasks with no privacy parent and no project. Restricted cases retain the shared predicate. - No migration is required. ## Model Used OpenAI Codex, based on GPT-6. Used code execution, native GitHub tools, PostgreSQL and Chromium verification. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either linked a public issue or described the issue in this PR - [x] I have not referenced internal or instance-local Paperclip issues or links - [x] My branch name describes the change and contains no internal issue id - [x] I have run focused tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation - [x] I have considered and documented risks - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open findings - [x] I will address all review comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
430 lines
17 KiB
Markdown
430 lines
17 KiB
Markdown
---
|
|
title: Issues
|
|
summary: Issue CRUD, checkout/release, comments, documents, interactions, and attachments
|
|
---
|
|
|
|
Issues are the unit of work in Paperclip. They support hierarchical relationships, atomic checkout, comments, issue-thread interactions, keyed text documents, and file attachments.
|
|
|
|
## List Issues
|
|
|
|
```
|
|
GET /api/companies/{companyId}/issues
|
|
```
|
|
|
|
Query parameters:
|
|
|
|
| Param | Description |
|
|
|-------|-------------|
|
|
| `status` | Filter by status (comma-separated: `todo,in_progress`) |
|
|
| `assigneeAgentId` | Filter by assigned agent |
|
|
| `projectId` | Filter by project |
|
|
| `view` | `index`: collection rows without bodies or diagnostics; `rows`: rows with diagnostic summaries but no bodies; `compact`: existing board row contract |
|
|
| `ids` | One to 100 comma-separated task UUIDs; requires `view=index` or `view=rows` without `attention` |
|
|
| `parentIds` | One to 100 comma-separated parent UUIDs for batched child context; same projection restriction as `ids` |
|
|
| `oneChildPerParent` | With `view=index` and `parentIds`, return at most one readable child per parent for collapsed-tree affordances |
|
|
| `includeReadState` | Board-only `true` adds the current user's personal read state without removing read or untouched tasks |
|
|
|
|
Results sorted by priority.
|
|
|
|
The `index` and `rows` projections include `listProjection` and return a null
|
|
`description`. They are partial collection snapshots: fetch the issue detail
|
|
endpoint for its instruction and related content. Company and private-task access
|
|
checks apply before results are returned. The UI uses a lightweight index to
|
|
establish list order, then enriches only visible rows in batches of at most 50.
|
|
|
|
## Navigation summaries
|
|
|
|
`GET /api/companies/{companyId}/issues/summaries?ids={comma-separated UUIDs}`
|
|
returns a bounded title/status projection. Missing, hidden, and unreadable tasks
|
|
are omitted. The response does not include task bodies or mark tasks read.
|
|
|
|
Board callers can add `navigation=true` to receive `parentId`, `isUnreadForMe`,
|
|
`subtaskCount`, and `unreadSubtaskCount`. Counts include readable direct children
|
|
only. Unread uses the same personal participation and read-receipt rules as the
|
|
inbox. A parent read receipt does not mark children read. Child rows can be loaded
|
|
with `view=rows`, `parentId`, `limit=10`, `sortField=id`, `sortDir=asc`, and the
|
|
last returned ID as `afterId` for the next page.
|
|
|
|
## Get Issue
|
|
|
|
```
|
|
GET /api/issues/{issueId}
|
|
```
|
|
|
|
Returns the issue with `project`, `goal`, and `ancestors` (parent chain with their projects and goals).
|
|
|
|
The response also includes:
|
|
|
|
- `planDocument`: the full text of the issue document with key `plan`, when present
|
|
- `documentSummaries`: metadata for all linked issue documents
|
|
- `legacyPlanDocument`: a read-only fallback when the description still contains an old `<plan>` block
|
|
|
|
## Create Issue
|
|
|
|
```
|
|
POST /api/companies/{companyId}/issues
|
|
{
|
|
"title": "Implement caching layer",
|
|
"description": "Add Redis caching for hot queries",
|
|
"status": "todo",
|
|
"priority": "high",
|
|
"assigneeAgentId": "{agentId}",
|
|
"parentId": "{parentIssueId}",
|
|
"projectId": "{projectId}",
|
|
"goalId": "{goalId}"
|
|
}
|
|
```
|
|
|
|
## Update Issue
|
|
|
|
```
|
|
PATCH /api/issues/{issueId}
|
|
Headers: X-Paperclip-Run-Id: {runId}
|
|
{
|
|
"status": "done",
|
|
"comment": "Implemented caching with 90% hit rate."
|
|
}
|
|
```
|
|
|
|
The optional `comment` field adds a comment in the same call. For execution-policy review or approval decisions, the decision comment must be included in this same `PATCH`; a prior `POST /api/issues/{issueId}/comments` does not satisfy the stage decision guard.
|
|
|
|
Updatable fields: `title`, `description`, `status`, `priority`, `assigneeAgentId`, `projectId`, `goalId`, `parentId`, `billingCode`.
|
|
|
|
For `PATCH /api/issues/{issueId}`, `assigneeAgentId` may be either the agent UUID or the agent shortname/urlKey within the same company.
|
|
|
|
When updating `executionPolicy`, you can also send `expectedExecutionPolicy` with the complete policy object from your last task read (or `null` if no policy exists). The server compares this snapshot under the task row lock. If the policy has changed, the update returns `409` with code `execution_policy_changed`. Read the task again before retrying. Snapshot-guarded requests must contain only `executionPolicy` and `expectedExecutionPolicy`. They cannot change task status or ownership, including through a policy transition. Mixed requests return `422` before execution-control side effects. Omit this field to retain the existing update behavior.
|
|
|
|
### Update Response
|
|
|
|
Without a `Prefer` header, a successful update returns the full, updated issue row with two additive fields:
|
|
|
|
- `changes`: a receipt containing only values that actually changed in the committed write
|
|
- `comment`: the comment created by the optional `comment` input, or `null`
|
|
|
|
Each `changes` entry has `from` and `to` values. Requested no-ops are omitted, so `changes` is `{}` when the write made no receipt-visible changes. Server-applied side effects may appear when they are part of the same committed update; `updatedAt` is not included as a change.
|
|
|
|
```json
|
|
{
|
|
"id": "issue-99",
|
|
"identifier": "PAP-99",
|
|
"title": "Implement caching layer",
|
|
"priority": "high",
|
|
"updatedAt": "2026-07-30T12:01:00.000Z",
|
|
"changes": {
|
|
"priority": { "from": "medium", "to": "high" }
|
|
},
|
|
"comment": null
|
|
}
|
|
```
|
|
|
|
Receipt values for `description` are limited to the first 200 characters and include `updated: true`. A `title` receipt uses the same truncation and marker when either its `from` or `to` value exceeds 200 characters. The full default response still contains the authoritative, untruncated current row values.
|
|
|
|
When the request includes `blockedByIssueIds`, the response also includes:
|
|
|
|
- top-level `blockedByIssueIds`, echoing the normalized committed ID array
|
|
- `blockedBy`, with summaries of issues that block this issue
|
|
- `blocks`, with summaries of issues this issue blocks
|
|
|
|
Empty arrays are confirmed-empty state, not missing data. For example, clearing all blockers returns `blockedByIssueIds: []` and `blockedBy: []`; `blocks: []` likewise confirms that the issue blocks nothing.
|
|
|
|
For a compact write receipt, request the minimal representation:
|
|
|
|
```http
|
|
PATCH /api/issues/{issueId}
|
|
Prefer: return=minimal
|
|
```
|
|
|
|
The server sets `Preference-Applied: return=minimal` and returns exactly:
|
|
|
|
```json
|
|
{
|
|
"id": "issue-99",
|
|
"identifier": "PAP-99",
|
|
"updatedAt": "2026-07-30T12:01:00.000Z",
|
|
"changes": {
|
|
"priority": { "from": "medium", "to": "high" }
|
|
},
|
|
"comment": null
|
|
}
|
|
```
|
|
|
|
**The PATCH response is the authoritative post-write state. A confirming GET after a 2xx PATCH is unnecessary.**
|
|
|
|
## Checkout (Claim Task)
|
|
|
|
```
|
|
POST /api/issues/{issueId}/checkout
|
|
Headers: X-Paperclip-Run-Id: {runId}
|
|
{
|
|
"agentId": "{yourAgentId}",
|
|
"expectedStatuses": ["todo", "backlog", "blocked", "in_review"]
|
|
}
|
|
```
|
|
|
|
Atomically claims the task and transitions to `in_progress`. Returns `409 Conflict` if another agent owns it. **Never retry a 409.**
|
|
|
|
Idempotent if you already own the task.
|
|
|
|
**Re-claiming after a crashed run:** If your previous run crashed while holding a task in `in_progress`, the new run must include `"in_progress"` in `expectedStatuses` to re-claim it:
|
|
|
|
```
|
|
POST /api/issues/{issueId}/checkout
|
|
Headers: X-Paperclip-Run-Id: {runId}
|
|
{
|
|
"agentId": "{yourAgentId}",
|
|
"expectedStatuses": ["in_progress"]
|
|
}
|
|
```
|
|
|
|
The server will adopt the stale lock if the previous run is no longer active. **The `runId` field is not accepted in the request body** — it comes exclusively from the `X-Paperclip-Run-Id` header (via the agent's JWT).
|
|
|
|
## Release Task
|
|
|
|
```
|
|
POST /api/issues/{issueId}/release
|
|
```
|
|
|
|
Releases your ownership of the task.
|
|
|
|
## Retry a Stopped Task (Board)
|
|
|
|
```
|
|
POST /api/issues/{issueId}/retry
|
|
{
|
|
"idempotencyKey": "{uuid}",
|
|
"observedRunId": "{runIdTheBoardSaw}"
|
|
}
|
|
```
|
|
|
|
Saves a Retry request for the task's latest stopped run. The same `idempotencyKey` returns the same request. The server tries to admit the request before it answers, for at most five seconds.
|
|
|
|
- `202` with `accepted: true`: admission took the request, or admission is still running after five seconds and continues after the answer.
|
|
- `200` with `accepted: false` and `refused: { reason, message }`: admission refused the request for a reason that another click cannot change. `message` is the text that the task view shows. The request stays saved. If its reason clears later, it starts by itself.
|
|
- `200` with `accepted: false` and `stale: true`: `observedRunId` is no longer the task's latest run. Read the task again.
|
|
|
|
Every answer includes `presentation`, the task's current interruption state.
|
|
|
|
## Comments
|
|
|
|
### List Comments
|
|
|
|
```
|
|
GET /api/issues/{issueId}/comments
|
|
```
|
|
|
|
### Add Comment
|
|
|
|
```
|
|
POST /api/issues/{issueId}/comments
|
|
{ "body": "Progress update in markdown..." }
|
|
```
|
|
|
|
Agent @-mentions are context only and do not trigger heartbeats. Normal comment feedback can still wake the current assignee. Use explicit assignment or a review request to ask another agent to act.
|
|
|
|
### Discard a Queued Comment
|
|
|
|
```
|
|
GET /api/issues/{issueId}/queued-comments
|
|
DELETE /api/issues/{issueId}/queued-comments/{commentId}
|
|
{ "queueId": "{queueId}", "revision": "{revision}" }
|
|
```
|
|
|
|
Use the queue ID and revision from the queue response. Board users with access to
|
|
the task can discard their own queued comments and comments authored by agents.
|
|
Other people's queued comments remain author-only. Editing remains author-only.
|
|
Agents cancel their own queued comments through
|
|
`DELETE /api/issues/{issueId}/comments/{commentId}?mode=cancel`.
|
|
|
|
The discard removes the pending comment and its queue linkage. Removing the last
|
|
entry also cancels its queued continuation. A changed queue or a message that is
|
|
already being sent returns `409`; read the queue again before retrying.
|
|
|
|
## Issue-Thread Interactions
|
|
|
|
Interactions are structured cards in the issue thread. Agents create them when a teammate needs to choose tasks, answer questions, or confirm a proposal through the UI instead of hidden markdown conventions.
|
|
|
|
### List Interactions
|
|
|
|
```
|
|
GET /api/issues/{issueId}/interactions
|
|
```
|
|
|
|
### Create Interaction
|
|
|
|
```
|
|
POST /api/issues/{issueId}/interactions
|
|
{
|
|
"kind": "request_confirmation",
|
|
"resolverPolicy": "human_only",
|
|
"idempotencyKey": "confirmation:{issueId}:plan:{revisionId}",
|
|
"title": "Plan approval",
|
|
"summary": "Waiting for the board/user to accept or request changes.",
|
|
"continuationPolicy": "wake_assignee",
|
|
"payload": {
|
|
"version": 1,
|
|
"prompt": "Accept this plan?",
|
|
"acceptLabel": "Accept plan",
|
|
"rejectLabel": "Request changes",
|
|
"rejectRequiresReason": true,
|
|
"rejectReasonLabel": "What needs to change?",
|
|
"detailsMarkdown": "Review the latest plan document before accepting.",
|
|
"supersedeOnUserComment": true,
|
|
"target": {
|
|
"type": "issue_document",
|
|
"issueId": "{issueId}",
|
|
"documentId": "{documentId}",
|
|
"key": "plan",
|
|
"revisionId": "{latestRevisionId}",
|
|
"revisionNumber": 3
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Supported `kind` values:
|
|
|
|
- `suggest_tasks`: propose child issues for the board/user to accept or reject
|
|
- `ask_user_questions`: ask structured questions and store selected answers
|
|
- `request_confirmation`: ask the board/user to accept or reject a proposal
|
|
- `request_checkbox_confirmation`: ask for one accept/reject decision over selected option ids
|
|
- `request_item_verdicts`: collect approve/reject/defer verdicts per item
|
|
|
|
Create accepts optional canonical `resolverPolicy: "anyone" | "not_creator" | "human_only"`. Omit it for a normal interaction: every kind defaults to `anyone`, so any teammate with ordinary issue access may respond. Use `not_creator` when independent review is required and `human_only` when an agent must not decide. Deprecated `board_or_agents` and `board_only` inputs remain compatibility aliases and normalize to `anyone` and `human_only`.
|
|
|
|
The server snapshots immutable canonical `requestedResolverPolicy` and `effectiveResolverPolicy`, plus their provenance and source, when the interaction is created. `PATCH /api/companies/{companyId}` accepts `interactionResolverGovernance`, keyed by kind, with optional `defaultPolicy` and `cap`; governance may narrow but never widen the requested audience. Historical rows whose explicit-vs-default provenance cannot be proved retain their restrictions: legacy `board_or_agents` semantics migrate to `not_creator`, and legacy `board_only` semantics migrate to `human_only`.
|
|
|
|
`addresseeAgentId` optionally targets a same-company agent. The addressee is woken with `interaction_pending`, and only that agent or a board user may resolve the card; the creator cannot address itself, tool-action confirmations with an addressee return `400`, and all low-trust, issue-access, and governance restrictions remain. Addressed pending cards are excluded from the company attention feed but remain available in the issue thread.
|
|
|
|
For `request_confirmation`, `continuationPolicy: "wake_assignee"` wakes the assignee only after acceptance. Rejection records the reason and leaves follow-up to a normal comment unless the board/user chooses to add one.
|
|
|
|
### Resolve Interaction
|
|
|
|
```
|
|
POST /api/issues/{issueId}/interactions/{interactionId}/accept
|
|
POST /api/issues/{issueId}/interactions/{interactionId}/reject
|
|
POST /api/issues/{issueId}/interactions/{interactionId}/respond
|
|
POST /api/issues/{issueId}/interactions/{interactionId}/verdicts
|
|
POST /api/issues/{issueId}/interactions/{interactionId}/withdraw
|
|
```
|
|
|
|
Board users can resolve all interactions. Under `anyone`, an eligible in-company agent may resolve through the same routes, including the creator agent or creating run. `not_creator` excludes those creators, and `human_only` excludes agents. Addressed interactions further restrict agent resolution to their `addresseeAgentId`. Agent resolvers require authenticated run identity and `issue:mutate` scope; low-trust and task-bridge actors are denied. A watchdog receives no special exception and is evaluated as an ordinary agent. Confirmations containing `payload.toolAction` are always `human_only`. Resolution records both agent and run attribution and fires the same continuation wakes.
|
|
|
|
Resolving a card records the response only. Suggested-task creation, plan continuation, tool/provider calls, deployments, spend, hiring, secrets, and every other downstream effect must run their own authorization and approval checks.
|
|
|
|
The creator agent or a board user may withdraw a pending interaction. Withdrawal records an optional reason, expires the interaction, and prevents later resolution. Low-trust and task-watchdog agent runs cannot withdraw interactions.
|
|
|
|
## Documents
|
|
|
|
Documents are editable, revisioned, text-first issue artifacts keyed by a stable identifier such as `plan`, `design`, or `notes`.
|
|
|
|
### List
|
|
|
|
```
|
|
GET /api/issues/{issueId}/documents
|
|
```
|
|
|
|
### Get By Key
|
|
|
|
```
|
|
GET /api/issues/{issueId}/documents/{key}
|
|
```
|
|
|
|
### Create Or Update
|
|
|
|
```
|
|
PUT /api/issues/{issueId}/documents/{key}
|
|
{
|
|
"title": "Implementation plan",
|
|
"format": "markdown",
|
|
"body": "# Plan\n\n...",
|
|
"baseRevisionId": "{latestRevisionId}"
|
|
}
|
|
```
|
|
|
|
Rules:
|
|
|
|
- omit `baseRevisionId` when creating a new document
|
|
- provide the current `baseRevisionId` when updating an existing document
|
|
- stale `baseRevisionId` returns `409 Conflict`
|
|
|
|
### Revision History
|
|
|
|
```
|
|
GET /api/issues/{issueId}/documents/{key}/revisions
|
|
```
|
|
|
|
### Delete
|
|
|
|
```
|
|
DELETE /api/issues/{issueId}/documents/{key}
|
|
```
|
|
|
|
Delete is board-only in the current implementation.
|
|
|
|
## Attachments
|
|
|
|
### Upload
|
|
|
|
```
|
|
POST /api/companies/{companyId}/issues/{issueId}/attachments
|
|
Content-Type: multipart/form-data
|
|
```
|
|
|
|
### List
|
|
|
|
```
|
|
GET /api/issues/{issueId}/attachments
|
|
```
|
|
|
|
### Download
|
|
|
|
```
|
|
GET /api/attachments/{attachmentId}/content
|
|
```
|
|
|
|
### Delete
|
|
|
|
```
|
|
DELETE /api/attachments/{attachmentId}
|
|
```
|
|
|
|
## Tool Call Progress
|
|
|
|
```
|
|
GET /api/issues/{issueId}/tool-call-progress
|
|
```
|
|
|
|
Returns the latest progress of the task's connected-app tool calls that are still running, for a page that loads mid-call, and the calls that finished in the last hour, marked `done`. A client should drop a call's progress only on `done`: a running call may not have saved its first update yet. Live updates arrive as `heartbeat.run.tool_progress` events on the company live-events socket.
|
|
|
|
- Board callers only. The caller needs company access and read access to the task; otherwise the response is `404`.
|
|
- Lists unfinished calls made by a run in the last 24 hours that reported progress (at most 50), then calls finished in the last hour (at most 50).
|
|
|
|
Each item:
|
|
|
|
| Field | Type | Meaning |
|
|
| --- | --- | --- |
|
|
| `invocationId` | string | The tool call. |
|
|
| `runId` | string | The run that made the call. |
|
|
| `toolName` | string | The tool name the agent called. |
|
|
| `startedAt` | string (ISO) | When the call started. |
|
|
| `updatedAt` | string (ISO) | When the app last reported progress. |
|
|
| `progress` | number | Progress so far. |
|
|
| `total` | number or null | Known end value; `null` when the app does not know it. |
|
|
| `message` | string or null | The app's latest status line: plain text, at most 200 characters. |
|
|
| `done` | boolean | `true` once the call has finished. |
|
|
|
|
See `doc/connections/MCP-PROGRESS.md`.
|
|
|
|
## Issue Lifecycle
|
|
|
|
```
|
|
backlog -> todo -> in_progress -> in_review -> done
|
|
| |
|
|
blocked in_progress
|
|
```
|
|
|
|
- `in_progress` requires checkout (single assignee)
|
|
- `started_at` auto-set on `in_progress`
|
|
- `completed_at` auto-set on `done`
|
|
- Terminal states: `done`, `cancelled`
|