Skip to content

Commit

Permalink
Add documentation for the new transfer route ownership endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
dalvarado authored and moleske committed Jul 28, 2022
1 parent 831c728 commit 8b858b9
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/v3/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
### 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).
To completely remove a space from a route, users will have to use [unshare route](#unshare-a-route-that-was-shared-with-different-space-experimental).

```
Example Request
```

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

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

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

#### Permitted roles

|
--- |
Admin |
Space Developer |
Space Supporter |
3 changes: 2 additions & 1 deletion docs/v3/source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,10 @@ includes:
- resources/routes/update
- resources/routes/delete
- resources/routes/check_route_reservations
- resources/routes/list_shared_routes
- resources/routes/list_shared_spaces
- resources/routes/share_routes
- resources/routes/unshare_routes
- resources/routes/transfer_route_ownership
- resources/routes/list_destinations
- resources/routes/insert_destinations
- resources/routes/replace_destinations
Expand Down

0 comments on commit 8b858b9

Please sign in to comment.