96411ba56a
Added documentation. Replaced PUT request with POST request. Added inline param support for PATCH request. Replaced unix timestamps handling with RFC-3339 timestampts handling. Added 'Bearer' method requirement for Authorization header. Change-Id: I4faa3864051dd18826c2c583ada53666d4aaec44
185 lines
4.3 KiB
Markdown
185 lines
4.3 KiB
Markdown
# Generated REST API design
|
|
|
|
Requires setting 'Authorization' header for requests.
|
|
|
|
## Successful responses
|
|
All the requests a non-empty body for the resource that we're interacting with.
|
|
|
|
Example:
|
|
|
|
```json
|
|
{
|
|
"project": {
|
|
"name": "My Awesome Project",
|
|
"description": "it is perfect"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Error responses
|
|
When an API endpoint returns an error (status code 4XX) it contains a JSON error response with 1 error field:
|
|
|
|
Example:
|
|
|
|
```json
|
|
{
|
|
"error": "authorization key format is incorrect. Should be 'Bearer <key>'"
|
|
}
|
|
```
|
|
|
|
### Project Management API Endpoints
|
|
Example of request
|
|
```bash
|
|
curl -i -L \
|
|
-H "Accept: application/json" \
|
|
-H 'Authorization: Bearer <key>' \
|
|
-X GET \
|
|
"https://satellite.qa.storj.io/api/v0/projects/"
|
|
```
|
|
#### GET projects/
|
|
Gets users projects.
|
|
|
|
!!!WARNING!!! Project ID is used as encryption salt. Please don't send it to anyone. We're going to fix it soon.
|
|
|
|
A successful response body:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id":"cd8d64bd-7457-4661-b88d-2e257bd0d88a",
|
|
"name":"My First Project",
|
|
"description":"",
|
|
"partnerId":"00000000-0000-0000-0000-000000000000",
|
|
"userAgent":null,
|
|
"ownerId":"f0ef7918-c8f0-4a9c-94fe-2260fb2a7877",
|
|
"rateLimit":null,
|
|
"burstLimit":null,
|
|
"maxBuckets":null,
|
|
"createdAt":"2022-04-15T11:38:36.951306+03:00",
|
|
"memberCount":0,
|
|
"storageLimit":"150.00 GB",
|
|
"bandwidthLimit":"150.00 GB",
|
|
"segmentLimit":150000
|
|
}
|
|
]
|
|
```
|
|
|
|
#### GET /bucket-rollup/projectID={uuid string}&bucket={string}&since={Date Timestamp like '2006-01-02T15:00:00Z'}&before={Date Timestamp like '2006-01-02T15:00:00Z'}
|
|
Gets project's single bucket usage by bucket ID.
|
|
|
|
!!!WARNING!!! Project ID is used as encryption salt. Please don't send it to anyone. We're going to fix it soon.
|
|
|
|
A successful response body:
|
|
|
|
```json
|
|
{
|
|
"projectID":"f4f2688e-8dae-4401-8ff1-31d9154ba514",
|
|
"bucketName":"bucket",
|
|
"totalStoredData":0.011384611174500622,
|
|
"totalSegments":0.21667078722222222,
|
|
"objectCount":0.10833539361111111,
|
|
"metadataSize":1.2241899478055554e-8,
|
|
"repairEgress":0,
|
|
"getEgress":0,
|
|
"auditEgress":0,
|
|
"since":"2006-01-02T15:00:00Z",
|
|
"before":"2022-04-27T23:59:59Z"
|
|
}
|
|
```
|
|
|
|
#### GET /bucket-rollups/projectID={uuid string}&since={Date Timestamp like '2006-01-02T15:00:00Z'}&before={Date Timestamp like '2006-01-02T15:00:00Z'}
|
|
Gets project's all buckets usage.
|
|
|
|
!!!WARNING!!! Project ID is used as encryption salt. Please don't send it to anyone. We're going to fix it soon.
|
|
|
|
A successful response body:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"projectID":"f4f2688e-8dae-4401-8ff1-31d9154ba514",
|
|
"bucketName":"bucket",
|
|
"totalStoredData":0.011384611174500622,
|
|
"totalSegments":0.21667078722222222,
|
|
"objectCount":0.10833539361111111,
|
|
"metadataSize":1.2241899478055554e-8,
|
|
"repairEgress":0,
|
|
"getEgress":0,
|
|
"auditEgress":0,
|
|
"since":"2006-01-02T15:00:00Z",
|
|
"before":"2022-04-27T23:59:59Z"
|
|
}
|
|
]
|
|
```
|
|
|
|
#### POST /create
|
|
Creates new Project with given info.
|
|
|
|
!!!WARNING!!! Project ID is used as encryption salt. Please don't send it to anyone. We're going to fix it soon.
|
|
|
|
Request body example:
|
|
|
|
```json
|
|
{
|
|
"name": "new project"
|
|
}
|
|
```
|
|
|
|
A successful response body:
|
|
|
|
```json
|
|
{
|
|
"id":"f4f2688e-8dae-4401-8ff1-31d9154ba514",
|
|
"name":"new project",
|
|
"description":"",
|
|
"partnerId":"00000000-0000-0000-0000-000000000000",
|
|
"userAgent":null,
|
|
"ownerId":"f0ef7918-c8f0-4a9c-94fe-2260fb2a7877",
|
|
"rateLimit":null,
|
|
"burstLimit":null,
|
|
"maxBuckets":null,
|
|
"createdAt":"2022-04-27T13:23:59.013381+03:00",
|
|
"memberCount":0,
|
|
"storageLimit":"15 GB",
|
|
"bandwidthLimit":"15 GB",
|
|
"segmentLimit":15000
|
|
}
|
|
```
|
|
|
|
#### PATCH /update/{uuid string}
|
|
Updates project with given info.
|
|
|
|
!!!WARNING!!! Project ID is used as encryption salt. Please don't send it to anyone. We're going to fix it soon.
|
|
|
|
Request body example:
|
|
|
|
```json
|
|
{
|
|
"name": "awesome project",
|
|
"description": "random stuff",
|
|
"bandwidthLimit": 1000000000,
|
|
"storageLimit": 1000000000
|
|
}
|
|
```
|
|
|
|
A successful response body:
|
|
|
|
```json
|
|
{
|
|
"id":"f4f2688e-8dae-4401-8ff1-31d9154ba514",
|
|
"name":"awesome project",
|
|
"description":"random stuff",
|
|
"partnerId":"00000000-0000-0000-0000-000000000000",
|
|
"userAgent":null,
|
|
"ownerId":"f0ef7918-c8f0-4a9c-94fe-2260fb2a7877",
|
|
"rateLimit":null,
|
|
"burstLimit":null,
|
|
"maxBuckets":null,
|
|
"createdAt":"2022-04-27T13:23:59.013381+03:00",
|
|
"memberCount":0,
|
|
"storageLimit":"1 GB",
|
|
"bandwidthLimit":"1 GB",
|
|
"segmentLimit":15000
|
|
}
|
|
```
|