sessions

List one directory level of a session workspace's full file tree, git-status decorated

Changed on
get/api/v1/sessions/{sessionId}/workspace/tree

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/sessions/{sessionId}/workspace/tree
  • Auth
    none declared

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Query parameters

filterstring

Case-insensitive path search across the selected snapshot.

commitShastring

Selected commit SHA.

snapshotboolean

Read the immutable review snapshot instead of the live worktree.

branchstring

Local or remote-tracking branch to read without checkout.

prNumberinteger

Associated pull request number.

sourceUrlstring

Associated pull request URL.

expectedTipShastring

Pinned source tip for snapshot reads. Must remain reachable from the selected source.

expectedBaseShastring

Pinned comparison base for snapshot reads.

commitShasstring

Comma-separated selected commit SHAs.

pathstring

Directory path relative to the session workspace root. Empty or omitted lists the root.

Response

OK

pathstring required
sessionIdstring required
snapshotboolean

True only when the tree was read from the requested immutable snapshot.

truncatedboolean required

Changes

  • 8f160e6183cdRevision changes
    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

  • 9fd7084a4f87Revision changes
    • info

      added the new optional query request parameter branch

    • info

      added the new optional query request parameter commitSha

    • info

      added the new optional query request parameter commitShas

    • info

      added the new optional query request parameter expectedBaseSha

    • info

      added the new optional query request parameter expectedTipSha

    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter prNumber

    • info

      added the new optional query request parameter snapshot

    • info

      added the new optional query request parameter sourceUrl

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status