Upload file

Creates or updates a file in a workspace.

Requirements:

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

File content options:

• Inline as binary data
• Via storage hints (storage_backend, storage_uri, sha1, size)

Parameters:

• mode - specifies file permissions
• mtime - sets the modification time

Validation: Reserved paths containing ‘.diversion’ are rejected.

Returns:

• 202 Accepted on success
• 204 No Content if no change was made

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

Upload file to a new or existing path

cURL

curl --request POST \
  --url https://api.diversion.dev/v0/repos/{repo_id}/files/{ref_id}/{path} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --header 'X-DV-Client-ID: <x-dv-client-id>' \
  --data '"<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

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"

Query Parameters

storage_backend · enum<integer>

An optional storage type for async upload. One of: 1 - EFS, 2 - S3

Available options: 1, 2

storage_uri · string

An optional storage uri to be sent along storage_backend. Coupled with storage_backend, a uri to storage location

Example:

"repo_id/2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"

mode · enum<integer> · required

The file mode (as Unix mode)

Available options: 16877, 33188, 33261, 40960

mtime · integer<int64> · required

The file's modification time in seconds since epoch

size · integer<int64>

Blob size in bytes

sha1 · string

A sha1 hexdigest

Body

application/octet-stream

Blob binary contents, if the file is a blob and if alternative storage solution was not used.

The body is of type file.

Response

202

File created or updated