Skip to main content
POST
/
repos
/
{repo_id}
/
shelves
/
{shelf_id}
/
apply
Apply a shelf onto a workspace
curl --request POST \
  --url https://api.diversion.dev/v0/repos/{repo_id}/shelves/{shelf_id}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workspace_id": "<string>",
  "delete_shelf": false
}'
{
  "merge_id": "example_id"
}

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"

​
shelf_id
string
required

Shelf identifier

Required string length: 3 - 128
Example:

"dv.shelf.12a37e91-bfc4-4e03-a330-13b5b84ab7cb"

Body

application/json
​
workspace_id
string
required

Workspace ID on which to apply the shelved changes

​
delete_shelf
boolean
default:false

Should shelf be deleted after applying it

Response

The merge is in progress. It has merge conflicts requiring active input from the user for conflict resolution. The response contains a merge ID, which can be used for querying /repos/{repo_id}/merges/{merge_id}

​
merge_id
string
required
Required string length: 3 - 128
Example:

"example_id"