Workspace status

Retrieves the current status of a workspace including:

• Counts of new files
• Counts of modified files
• Counts of deleted files
• Optionally detailed file entries

Features:

• Pagination via limit and skip
• Filtering by path_prefix
• Recursive/non-recursive listing via recurse parameter
• detail_items parameter controls whether full file entries are returned
• Results filtered based on path permissions
• Supports caching and ETags for performance

GET /repos/{repo_id}/workspaces/{workspace_id}/status

Get status of changes in workspace

cURL

curl --request GET \
  --url https://api.diversion.dev/v0/repos/{repo_id}/workspaces/{workspace_id}/status \
  --header 'Authorization: Bearer <token>'

200

{
  "changed_items_count": 123,
  "changed_files_count": 123,
  "incomplete_result": true,
  "items": {
    "new": [
      {
        "path": "hello.cc",
        "prev_path": "<string>",
        "mtime": "2023-11-07T05:31:56Z",
        "blob": {
          "storage_uri": "repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
          "size": 123,
          "sha": "<string>"
        }
      }
    ],
    "modified": [
      {
        "path": "hello.cc",
        "prev_path": "<string>",
        "mtime": "2023-11-07T05:31:56Z",
        "blob": {
          "storage_uri": "repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
          "size": 123,
          "sha": "<string>"
        }
      }
    ],
    "deleted": [
      {
        "path": "hello.cc",
        "prev_path": "<string>",
        "mtime": "2023-11-07T05:31:56Z",
        "blob": {
          "storage_uri": "repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed",
          "size": 123,
          "sha": "<string>"
        }
      }
    ]
  },
  "conflicts": [
    "<string>"
  ]
}

Authorizations

OAuth2OAuth2

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"

Query Parameters

detail_items · boolean · default: true

Should detail all the changed items in status response

limit · integer

Limit the number of entries returned from walk

Required range: x >= 1

Example:

17

recurse · boolean · default: true

Specifies if to recursively iterate file tree to next directory levels

path_prefix · string<path>

A path prefix in the file tree to walk under

Example:

"path/to/file"

Response

200

application/json

The changes made to this workspace since the commit it's based upon.

The status of the workspace, meaning its bill of changes. It will contain the total number of changed items and specifically changed files. If paths details were requested, it will also contain an object having 'new', 'modified', 'deleted' arrays of file entries, sorted lexicographically.

changed_items_count · number · required

Number of changed items of all types

changed_files_count · number · required

Number of changed files

incomplete_result · boolean

The result list was trimmed and the counts are a lower bound only

items · object

Drill down into modified items by change type

Show child attributes

conflicts · string[] | null

List of conflicted file paths, compared to the base branch, if applicable