Reset changes in workspace

Resets uncommitted changes in a workspace by discarding modifications and optionally deleting added files.

Parameters:

• all=true - reset everything
• paths array - reset specific files
• delete_added (defaults to false) - controls whether newly added files are deleted
• write_to_journal (defaults to true) - records the reset operation

Returns: Lists of:

• Succeeded paths
• Failed paths
• Skipped paths

Requirements: Requires WRITE access.

POST /repos/{repo_id}/workspaces/{workspace_id}/reset

Reset changes in workspace

cURL

curl --request POST \
  --url https://api.diversion.dev/v0/repos/{repo_id}/workspaces/{workspace_id}/reset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "all": true,
  "paths": [
    "<string>"
  ]
}
'

200

{
  "success": [
    "<string>"
  ],
  "fail": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

workspace_id · string · required

The repo ID of the workspace.

Required string length: 3 - 128

Example:

"example_id"

Body

application/json

all · boolean

paths · string[] | null

Inclusion list of paths to include in the operation. If null, all paths will be included.

Minimum array length: 1

A relative path to a file or directory inside the repository.

Minimum string length: 1

Response

200

application/json

The updated status of the workspace

Response of a reset command.

success · string[] · required

Paths that were successfully reset.

fail · string[] · required

Paths that were not found.