Delete Compose document permanently

Outcome

Permanently delete a document and its saved versions in the selected workspace. The successful raw response is HTTP 204 with an empty body and no identifier.

Before you start

• Verify the authenticated identity, environment and pinned organization before preparing an action.
• The published application permission is workspace:write. Discover and select a granted Compose workspace separately from action input. A supplied identifier does not grant access.
• A read_write workspace grant is required, including model suggestion previews that do not persist document text.
• Authorize the documented effects or private-data export before CLI --confirm or MCP confirm:true. HTTP method alone does not establish a read-only operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_compose.documents.delete --detail --json
topolo resources topolo-compose --json
topolo workspaces list topolo-compose --json

• Select the granted workspace id as COMPOSE_WORKSPACE_ID. Use document and version ids returned by accessible reads; fixture ids confer no live access.

Request

DELETE /api/documents/{documentId}

Save action input as payload.json. Inspect the plan for the exact path, query and body. Set COMPOSE_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console, then perform the verification below.

Input fields

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "documentId"
  ],
  "additionalProperties": false
}

Effects

• Deletes the target document and all of its saved versions.
• Returns no documentId or receipt payload; retain the discovered request identifier.
• This is different from archival, which retains content and history.

Interpret the response

HTTP 204 has an empty body and no response identifier. Retain the discovered documentId from the request and verify absence.

Expect HTTP 204 with an empty response. Use documents.get and documents.versions.list for the same identifier and workspace to confirm 404. Do not infer erasure of other services or organization-wide records from this response.

The success schema below was checked against captured handler responses. Optional structured generation metadata and integration-dependent values can vary. Error examples retain their actual refusal shapes.

Success schema:

{
  "type": "string",
  "const": "",
  "description": "HTTP 204 with no response body; SDK transport returns exactly an empty string."
}

Worked examples

Responses were captured from the actual Compose Worker using synthetic users, organizations, content and identifiers. Tests simulate Auth, Nexus, Notify, metering and platform workspace transport and use an in-memory D1 adapter or local SQLite. They prove local handler behavior, not live model correctness, provider cost, notification delivery, real workspace grants or cross-store atomicity. HTTP 204 responses are exactly empty strings in the SDK transport. Replace fixture identifiers through credential-scoped discovery. Refused examples demonstrate boundaries and must not be executed as successful workflows.

Successful request

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: document CRUD > DELETE removes a document and its versions.

Input · payload.json:

{
  "documentId": "686720e6-4324-4f4d-9731-35b32569b4cf"
}

CLI:

topolo actions validate app_topolo_compose.documents.delete --data @payload.json --json
topolo actions plan app_topolo_compose.documents.delete --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_compose.documents.delete --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_compose.documents.delete",
    "input": {
      "documentId": "686720e6-4324-4f4d-9731-35b32569b4cf"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 204:

HTTP 204. Expect HTTP 204 with an empty response. Use documents.get and documents.versions.list for the same identifier and workspace to confirm 404. Do not infer erasure of other services or organization-wide records from this response.

Refused request · HTTP 404

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: compose workspace data isolation > a cross-workspace mutation (PATCH/DELETE) fails closed with 404.

Input · payload.json:

{
  "documentId": "ac3e2f43-0367-41aa-b862-584e02aa5f9f"
}

CLI:

topolo actions validate app_topolo_compose.documents.delete --data @payload.json --json
topolo actions plan app_topolo_compose.documents.delete --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": "not_found"
}

HTTP 404. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Refused request · HTTP 403

Actual Compose Worker response. Auth, Nexus, notifications, metering and platform workspace transport are simulated. D1 is an in-memory adapter or local SQLite as stated by the test. This does not prove a live model completion or notification delivery. No request credentials are captured. Captured scenario: each grant level against each route > 'DELETE' '/api/documents/{documentId}' with a 'read' grant.

Input · payload.json:

{
  "documentId": "documentId_missing"
}

CLI:

topolo actions validate app_topolo_compose.documents.delete --data @payload.json --json
topolo actions plan app_topolo_compose.documents.delete --resource-type workspace --resource-id "$COMPOSE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": "This workspace requires read_write access",
  "code": "workspace_access_insufficient"
}

HTTP 403. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Verify the result

• Expect HTTP 204 with an empty response.
• Use documents.get and documents.versions.list for the same identifier and workspace to confirm 404. Do not infer erasure of other services or organization-wide records from this response.

Errors and recovery

• not_found (HTTP 404): Discover the accessible document and version in the selected workspace. A missing or inaccessible id is not permission to create a replacement.
• This workspace requires read_write access (HTTP 403): Verify the authenticated organization, application permission and granted workspace. For reviewer_required, use the legitimately assigned reviewer; requesting review grants no access.

Auth, action-input validation and platform resource resolution can refuse a request before its handler. Retain the exact error, request id and context; requesting another context is not a legitimate way to bypass a refusal.

Recovery boundary

There is no Compose undelete action. Prefer documents.archive when retention is intended; authorize permanent loss explicitly and preserve an authorized copy before deleting if needed.

Related actions

• Get Compose document: Read one document in the authorized organization and workspace, including current markdown, provenance, approval metadata and archival state. This read can initialize the local workspace mirror.
• List saved Compose document versions: Read the 25 newest saved snapshots of an accessible document. This read can initialize the local workspace mirror and exposes no continuation cursor.
• Archive Compose document: Hide a document from the active list by setting archivedAt, while retaining its content and saved versions. Archived documents still count toward the workspace archival emptiness check.

Evidence

Responses were captured from the actual Compose Worker using synthetic users, organizations, content and identifiers. Tests simulate Auth, Nexus, Notify, metering and platform workspace transport and use an in-memory D1 adapter or local SQLite. They prove local handler behavior, not live model correctness, provider cost, notification delivery, real workspace grants or cross-store atomicity. HTTP 204 responses are exactly empty strings in the SDK transport. Replace fixture identifiers through credential-scoped discovery. Capture digests and test scenarios are retained in the source fixture records.