Update workspace preferences

Updates workspace preferences, specifically the sync_paths_rules array that controls which paths are synchronized.

Validation: New rules are validated to ensure no unselected paths contain uncommitted changes.

Requirements: Requires WRITE access to the repository.

Returns:

• 409 Conflict if attempting to deselect paths with changes (must commit or reset first)
• 202 Accepted on success

PUT /repos/{repo_id}/workspaces/{workspace_id}/preferences

Update the preferences of the current user

cURL

curl --request PUT \
  --url https://api.diversion.dev/v0/repos/{repo_id}/workspaces/{workspace_id}/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sync_paths_rules": [
    "<string>"
  ]
}
'

default

{
  "status": 403,
  "detail": "User not authorized to perform the requested action on the resource",
  "title": "<string>",
  "type": "<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

Preferences associated with a user for a workspace

sync_paths_rules · string[] · required

List of rules setting which paths to sync, an empty list means sync all

Response

202

Request completed successfully