-
Notifications
You must be signed in to change notification settings - Fork 363
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for the new transfer route ownership endpoint
- Loading branch information
Showing
4 changed files
with
35 additions
and
1 deletion.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
File renamed without changes.
32 changes: 32 additions & 0 deletions
32
docs/v3/source/includes/resources/routes/_transfer_route_ownership.md.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters