Skip to content

Commit

Permalink
Update transfer-route docs to reflect changes in the endpoint (#2912)
Browse files Browse the repository at this point in the history
Authored-by: Merric de Launey <[email protected]>
  • Loading branch information
MerricdeLauney authored Aug 15, 2022
1 parent f90c499 commit 2ab201a
Showing 1 changed file with 8 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,27 +1,31 @@
### Transfer ownership (experimental)

Transfers a the ownership of a route to a another space. Users must have write access for both spaces to perform this action.
The original owning space will still retain read and write access to route via [shared spaces](#share-a-route-with-other-spaces-experimental).
The original owning space will still retain access to the route as a [shared space](#share-a-route-with-other-spaces-experimental).
To completely remove a space from a route, users will have to use [unshare route](#unshare-a-route-that-was-shared-with-another-space-experimental).

```
Example Request
```

```shell
curl "https://api.example.org/v3/routes/:route-guid/transfer_owner" \
curl "https://api.example.org/v3/routes/:route-guid/relationships/space" \
-X PATCH \
-H "Authorization: bearer [token]" \
-H "Content-type: application/json"
-d '{ "guid": "space-2-guid" }'
-d '{ "data": { "guid": "space-guid"} }'
```

```
Example Response
```

```http
HTTP/1.1 204 No Content
```

#### Definition
`PATCH /v3/routes/:route-guid/transfer_owner`
`PATCH /v3/routes/:route-guid/relationships/space`

#### Permitted roles

Expand Down

0 comments on commit 2ab201a

Please sign in to comment.