JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

satellite/admin: Add clarifications in README

Browse Source 
Add some clarifications to the README of the satellite admin API.

Change-Id: I2f56c8778872a098442ecd601c2b8dcfe1ac19a2
This commit is contained in:
Ivan Fraixedes 2021-05-05 20:41:16 +02:00
parent 0d3865950f
commit 1504303363
No known key found for this signature in database
GPG Key ID: 042B474597F96DB7
1 changed files with 54 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
satellite/admin/README.md
View File

@ -100,6 +100,10 @@ Deletes the user.
## Coupon Management
The coupons have an amount and duration.
Amount is expressed in cents of USD dollars (e.g. 500 is $5)
Duration is expressed in billing periods, a billing period is a natural month.
### POST /api/coupon
Adds a coupon for specific user.
@ -169,50 +173,6 @@ A successful response body:
}
```
### GET /api/project/{project-id}/usage
This endpoint returns whether the project has outstanding usage or not.
A project with not usage returns status code 200 and `{"result":"no project usage exist"}`.
### GET /api/project/{project-id}/limit
This endpoint returns information about project limits.
A successful response body:
```json
{
"usage": {
"amount": "1.0 TB",
"bytes": 1000000000000
},
"bandwidth": {
"amount": "1.0 TB",
"bytes": 1000000000000
},
"rate": {
"rps": 0
}
}
```
### POST /api/project/{project-id}/limit?usage={value}
Updates usage limit for a project.
### POST /api/project/{project-id}/limit?bandwidth={value}
Updates bandwidth limit for a project.
### POST /api/project/{project-id}/limit?rate={value}
Updates rate limit for a project.
### POST /api/project/{project-id}/limit?buckets={value}
Updates bucket limit for a project.
### GET /api/project/{project-id}
Gets the common information about a project.
@ -258,8 +218,57 @@ A successful response body:
Deletes the given apikey by its name.
### GET /api/project/{project-id}/usage
This endpoint returns whether the project has outstanding usage or not.
A project with not usage returns status code 200 and `{"result":"no project usage exist"}`.
### GET /api/project/{project-id}/limit
This endpoint returns information about project limits.
A successful response body:
```json
{
"usage": {
"amount": "1.0 TB",
"bytes": 1000000000000
},
"bandwidth": {
"amount": "1.0 TB",
"bytes": 1000000000000
},
"rate": {
"rps": 0
}
}
```
### Update limits
You can update the different limits with one single request just adding the
various query parameters (e.g. `usage=5000000&bandwidth=9000000`)
#### POST /api/project/{project-id}/limit?usage={value}
Updates usage limit for a project. The value must be in bytes.
#### POST /api/project/{project-id}/limit?bandwidth={value}
Updates bandwidth limit for a project. The value must be in bytes.
#### POST /api/project/{project-id}/limit?rate={value}
Updates rate limit for a project.
#### POST /api/project/{project-id}/limit?buckets={value}
Updates bucket limit for a project.
## APIKey Management
### DELETE /api/apikey/{apikey}
Deletes the given apikey.
Deletes the given apikey.