Rename file

Outcome

Copy one existing file and its metadata to an unused key, move available thumbnails, delete the old object and schedule semantic reindexing.

Before you start

• Verify identity, pin environment and organization, and discover a granted Bytes workspace before choosing file keys.
• The action requires files:write. Select a verified workspace resource separately from action input; a body field cannot supply a workspace grant.
• Scope org uses the verified workspace shared root; private uses the caller’s private subtree. The accepted legacy all value resolves to org and does not grant cross-organization browsing. The bucket input cannot switch the configured R2 binding.
• Authorize the described effect or private-data export before passing CLI --confirm or MCP confirm:true. GET listing/search can persist derived data; HTTP method alone does not establish a read-only action.

Discover the target

topolo whoami --json
topolo actions get app_topolo_bytes.files.rename --detail --json
topolo resources topolo-bytes --json
topolo workspaces list topolo-bytes --json

• File keys are paths returned by files.list/search in the selected workspace and scope. Discover the granted workspace id; do not derive access from fixture ids.

Request

POST /api/rename

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and the HTTP body. Set BYTES_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "oldKey": {
      "type": "string",
      "minLength": 1
    },
    "newKey": {
      "type": "string",
      "minLength": 1
    },
    "bucket": {
      "type": "string",
      "minLength": 1
    },
    "scope": {
      "type": "string",
      "enum": [
        "org",
        "private",
        "all"
      ]
    }
  },
  "required": [
    "oldKey",
    "newKey"
  ],
  "additionalProperties": false
}

Effects

• Changes the file key and schedules thumbnail/index work. Existing share records are not rewritten; do not assume links follow the new path.

Interpret the response

The response identifier path is $.newKey for file. An empty list does not discover a target.

List the new key and absence of old key. Inspect any existing shares separately; queued index/thumbnail work can fail independently.

The schema describes supported success fields; optional metadata and integration-dependent values may vary. Errors have the exact shapes shown in refused examples.

Success schema:

{
  "type": "object",
  "required": [
    "success",
    "oldKey",
    "newKey",
    "message"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "oldKey": {
      "type": "string"
    },
    "newKey": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Worked examples

Actual exported Worker handlers with local Miniflare R2/KV. Auth, workspace grants, R2 multipart, notification, usage and semantic integrations are simulated at their configured test boundaries. Synthetic ids, timestamps and signed URLs confer no live access. No deployed provider outcome, external delivery or live grant is established. Upload-session credential values are explicitly redacted; binary responses use the tested SDK transport envelope. Replace synthetic identifiers through credential-scoped discovery. Refused scenarios document failure boundaries; they are not successful workflows.

Successful request

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "oldKey": "orig.txt",
  "newKey": "renamed.txt"
}

CLI:

topolo actions validate app_topolo_bytes.files.rename --data @payload.json --json
topolo actions plan app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_bytes.files.rename",
    "input": {
      "oldKey": "orig.txt",
      "newKey": "renamed.txt"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "success": true,
  "oldKey": "orig.txt",
  "newKey": "renamed.txt",
  "message": "File renamed successfully"
}

HTTP 200. List the new key and absence of old key. Inspect any existing shares separately; queued index/thumbnail work can fail independently.

Refused request · HTTP 400

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "oldKey": "a.txt"
}

CLI:

topolo actions validate app_topolo_bytes.files.rename --data @payload.json --json
topolo actions plan app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 400:

{
  "success": false,
  "error": "Both oldKey and newKey are required"
}

HTTP 400. This request was refused; preserve the exact response and correct its cause before retrying.

Refused request · HTTP 400

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "oldKey": "a.txt",
  "newKey": "a.txt"
}

CLI:

topolo actions validate app_topolo_bytes.files.rename --data @payload.json --json
topolo actions plan app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 400:

{
  "success": false,
  "error": "New key must be different from old key"
}

HTTP 400. This request was refused; preserve the exact response and correct its cause before retrying.

Refused request · HTTP 404

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "oldKey": "ghost.txt",
  "newKey": "new.txt"
}

CLI:

topolo actions validate app_topolo_bytes.files.rename --data @payload.json --json
topolo actions plan app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "success": false,
  "error": "Source file not found"
}

HTTP 404. This request was refused; preserve the exact response and correct its cause before retrying.

Refused request · HTTP 409

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "oldKey": "src.txt",
  "newKey": "dst.txt"
}

CLI:

topolo actions validate app_topolo_bytes.files.rename --data @payload.json --json
topolo actions plan app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 409:

{
  "success": false,
  "error": "Destination file already exists"
}

HTTP 409. This request was refused; preserve the exact response and correct its cause before retrying.

Refused request · HTTP 403

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "oldKey": "a.txt",
  "newKey": "b.txt",
  "scope": "private"
}

CLI:

topolo actions validate app_topolo_bytes.files.rename --data @payload.json --json
topolo actions plan app_topolo_bytes.files.rename --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": "Forbidden",
  "message": "You do not have permission to rename this file"
}

HTTP 403. This request was refused; preserve the exact response and correct its cause before retrying.

Verify the result

• List the new key and absence of old key. Inspect any existing shares separately; queued index/thumbnail work can fail independently.

Errors and recovery

• Both oldKey and newKey are required (HTTP 400): Correct the exact fields using the discovered input schema and prerequisites. Refused input examples demonstrate errors and must not be executed as successful workflows.
• New key must be different from old key (HTTP 400): Correct the exact fields using the discovered input schema and prerequisites. Refused input examples demonstrate errors and must not be executed as successful workflows.
• Source file not found (HTTP 404): Discover the existing file, share or release in the intended scope. A missing or inaccessible target is not authorization to create a replacement.
• Destination file already exists (HTTP 409): Inspect the existing target and workspace state. Resolve the documented conflict before resubmitting; do not erase content to bypass an emptiness or destination check.
• Forbidden (HTTP 403): Verify the pinned organization, granted workspace resource and required application permission. Inspect the exact refusal before requesting narrower access; never switch scope to bypass the denial.

Authentication, the action-input validator or resource middleware can refuse a request before this handler. Preserve the exact request id, error and selected credential context. The fixtures establish no live credentials or configured provider.

Recovery boundary

After verifying a successful rename, rename back only if the old key is still available. Capture prior paths and metadata first.

Related actions

• List files: List one page of files and directories in the verified workspace; eligible files can have derived thumbnails generated during listing.

Evidence

Actual exported Worker handlers with local Miniflare R2/KV. Auth, workspace grants, R2 multipart, notification, usage and semantic integrations are simulated at their configured test boundaries. Synthetic ids, timestamps and signed URLs confer no live access. No deployed provider outcome, external delivery or live grant is established. Upload-session credential values are explicitly redacted; binary responses use the tested SDK transport envelope. Capture digests and test scenarios are retained in the source fixture records.