Delete file

Deletes a file or directory at the specified path in a workspace.

Requirements:

• The ref_id must be a workspace ID
• Requires a client ID header

Behavior: The deletion is recorded in the workspace’s draft commit and can be reverted before committing.

Returns:

• 404 Not Found if the path doesn’t exist
• 202 Accepted on successful deletion

DELETE /repos/{repo_id}/files/{ref_id}/{path}

Delete a file from an existing path

cURL

curl --request DELETE \
  --url https://api.diversion.dev/v0/repos/{repo_id}/files/{ref_id}/{path} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-DV-Client-ID: <x-dv-client-id>'

404

{
  "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

Headers

X-DV-Client-ID · string · required

The unique id of the client making this request

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"

ref_id · string · required

An ID of a workspace, branch or commit.

Required string length: 3 - 128

Example:

"example_id"

path · string<path> · required

A path to a file inside the repository.

Example:

"/path/to/file"

Response

202

File deleted