sessions

Read grouped unified patches for a bounded set of workspace files

Changed on
post/api/v1/sessions/{sessionId}/workspace/diffs

Request

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

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Request body

branchstring

Local branch to read instead of the checked-out worktree. Requires the committed scope.

commitShastring

Exact commit SHA for a committed-scope comparison. Cannot be combined with commitShas.

commitShasstring[]

Full SHAs whose combined changes are compared. Requires the committed scope.

contextLinesinteger required
expectedBaseShastring

The view's baseSha from its history. A moved base fails with WORKSPACE_REF_MOVED.

expectedTipShastring

The view's tipSha from its history. A moved tip fails with WORKSPACE_REF_MOVED.

ignoreWhitespaceboolean required
pathsstring[] required
prNumberinteger

Associated pull request to read instead of the checked-out worktree. Requires the committed scope.

scope'combined' | 'uncommitted' | 'committed' | 'staged' | 'unstaged' | 'untracked' required
sourceUrlstring

Stable URL of the pull request, for PRs that share a number. Requires prNumber.

workspaceVersionstring

Response

OK

sessionIdstring required
workspaceVersionstring 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 request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new uncommitted enum value to the request property