Deuxfleurs/garage
42
39
Fork 55
Code Issues 73 Pull requests 7 Releases 29 Wiki Activity

Update json in admin api doc
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details

Browse source
This commit is contained in:
Alex 2022-06-10 11:30:42 +02:00
parent 180e7fef0a
commit 92d912faef
Signed by: lx
GPG key ID: 0E496D15096376BE
1 changed files with 77 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

147
doc/book/reference-manual/admin-api.md
View file

@ -134,8 +134,8 @@ Example request body:
```json ```json
[ [
"ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f@10.0.0.11:3901", "ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f@10.0.0.11:3901",
"4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff@10.0.0.12:3901" "4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff@10.0.0.12:3901"
] ]
``` ```
@ -145,14 +145,14 @@ Example response:
```json ```json
[ [
{ {
"success": true, "success": true,
"error": null "error": null
}, },
{ {
"success": false, "success": false,
"error": "Handshake error" "error": "Handshake error"
} }
] ]
``` ```
@ -301,7 +301,7 @@ Request body format:
```json ```json
{ {
"name": "NameOfMyKey" "name": "NameOfMyKey"
} }
``` ```
@ -313,9 +313,9 @@ Request body format:
```json ```json
{ {
"accessKeyId": "GK31c2f218a2e44f485b94239e", "accessKeyId": "GK31c2f218a2e44f485b94239e",
"secretAccessKey": "b892c0665f0ada8a4755dae98baa3b133590e11dae3bcc1f9d769d67f16c3835", "secretAccessKey": "b892c0665f0ada8a4755dae98baa3b133590e11dae3bcc1f9d769d67f16c3835",
"name": "NameOfMyKey" "name": "NameOfMyKey"
} }
``` ```
@ -403,11 +403,11 @@ Request body format:
```json ```json
{ {
"name": "NameOfMyKey", "name": "NameOfMyKey",
"allow": { "allow": {
"createBucket": true, "createBucket": true,
}, },
"deny": {} "deny": {}
} }
``` ```
@ -473,24 +473,31 @@ Example response:
```json ```json
{ {
"id": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b", "id": "afa8f0a22b40b1247ccd0affb869b0af5cff980924a20e4b5e0720a44deb8d39",
"globalAliases": [ "globalAliases": [],
"alex" "websiteAccess": false,
], "websiteConfig": null,
"keys": [ "keys": [
{ {
"accessKeyId": "GK31c2f218a2e44f485b94239e", "accessKeyId": "GK31c2f218a2e44f485b94239e",
"name": "alex", "name": "Imported key",
"permissions": { "permissions": {
"read": true, "read": true,
"write": true, "write": true,
"owner": true "owner": true
}, },
"bucketLocalAliases": [ "bucketLocalAliases": [
"test" "debug"
] ]
} }
] ],
"objects": 14827,
"bytes": 13189855625,
"unfinshedUploads": 0,
"quotas": {
"maxSize": null,
"maxObjects": null
}
} }
``` ```
@ -502,7 +509,7 @@ Request body format:
```json ```json
{ {
"globalAlias": "NameOfMyBucket" "globalAlias": "NameOfMyBucket"
} }
``` ```
@ -510,15 +517,15 @@ OR
```json ```json
{ {
"localAlias": { "localAlias": {
"accessKeyId": "GK31c2f218a2e44f485b94239e", "accessKeyId": "GK31c2f218a2e44f485b94239e",
"alias": "NameOfMyBucket", "alias": "NameOfMyBucket",
"allow": { "allow": {
"read": true, "read": true,
"write": true, "write": true,
"owner": false "owner": false
} }
} }
} }
``` ```
@ -548,15 +555,15 @@ Request body format:
```json ```json
{ {
"websiteAccess": { "websiteAccess": {
"enabled": true, "enabled": true,
"indexDocument": "index.html", "indexDocument": "index.html",
"errorDocument": "404.html" "errorDocument": "404.html"
}, },
"quotas": { "quotas": {
"maxSize": 19029801, "maxSize": 19029801,
"maxObjects": null, "maxObjects": null,
} }
} }
``` ```
@ -582,13 +589,13 @@ Request body format:
```json ```json
{ {
"bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b", "bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b",
"accessKeyId": "GK31c2f218a2e44f485b94239e", "accessKeyId": "GK31c2f218a2e44f485b94239e",
"permissions": { "permissions": {
"read": true, "read": true,
"write": true, "write": true,
"owner": true "owner": true
}, },
} }
``` ```
@ -603,13 +610,13 @@ Request body format:
```json ```json
{ {
"bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b", "bucketId": "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b",
"accessKeyId": "GK31c2f218a2e44f485b94239e", "accessKeyId": "GK31c2f218a2e44f485b94239e",
"permissions": { "permissions": {
"read": false, "read": false,
"write": false, "write": false,
"owner": true "owner": true
}, },
} }
``` ```