aboutsummaryrefslogtreecommitdiff
path: root/doc/drafts/admin-api.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-05-24 11:52:33 +0200
committerAlex Auvolat <alex@adnab.me>2022-05-24 11:52:33 +0200
commit0b43a7135153428f036be2056e197041797b0997 (patch)
tree42c57999992e2f2f59dc45957696b7fff257281f /doc/drafts/admin-api.md
parent2f250a83e14e7fa10810e2bb9925cc125baf670c (diff)
downloadgarage-0b43a7135153428f036be2056e197041797b0997.tar.gz
garage-0b43a7135153428f036be2056e197041797b0997.zip
Fix some docs and change syntax of CreateBucket permissions
Diffstat (limited to 'doc/drafts/admin-api.md')
-rw-r--r--doc/drafts/admin-api.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md
index e6ce6336..b35a87f1 100644
--- a/doc/drafts/admin-api.md
+++ b/doc/drafts/admin-api.md
@@ -124,11 +124,11 @@ Example response:
[
{
"success": true,
- "error": null,
+ "error": null
},
{
"success": false,
- "error": "Handshake error",
+ "error": "Handshake error"
}
]
```
@@ -490,7 +490,11 @@ OR
"localAlias": {
"accessKeyId": "GK31c2f218a2e44f485b94239e",
"alias": "NameOfMyBucket",
- "allPermissions": true
+ "allow": {
+ "read": true,
+ "write": true,
+ "owner": false
+ }
}
}
```
@@ -504,6 +508,9 @@ OR
Creates a new bucket, either with a global alias, a local one,
or no alias at all.
+Technically, you can also specify both `globalAlias` and `localAlias` and that would create
+two aliases, but I don't see why you would want to do that.
+
#### DeleteBucket `DELETE /v0/bucket?id=<bucket id>`
Deletes a storage bucket. A bucket cannot be deleted if it is not empty.
@@ -519,7 +526,7 @@ Request body format:
```json
{
"indexDocument": "index.html",
- "errorDocument": "404.html",
+ "errorDocument": "404.html"
}
```