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

satellite/admin: Add a ToC to README

Browse Source 
Add an auto-generated table of content to the README for easy to find
and browser the documentation of the available API end points.

Change-Id: Id94d904cefd30449234224072ddc50a181aaba04
This commit is contained in:
Ivan Fraixedes 2021-05-06 07:22:14 +02:00
parent 1504303363
commit 2f8969ae35
No known key found for this signature in database
GPG Key ID: 042B474597F96DB7
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
satellite/admin/README.md
View File

@ -4,6 +4,37 @@ Satellite Admin package provides API endpoints for administrative tasks.
Requires setting `Authorization` header for requests.
<!-- Aut-generate this ToC with https://github.com/ycd/toc -->
<!-- toc -->
- [satellite/admin](#satelliteadmin)
* [User Management](#user-management)
* [POST /api/user](#post-apiuser)
* [PUT /api/user/{user-email}](#put-apiuseruser-email)
* [GET /api/user/{user-email}](#get-apiuseruser-email)
* [DELETE /api/user/{user-email}](#delete-apiuseruser-email)
* [Coupon Management](#coupon-management)
* [POST /api/coupon](#post-apicoupon)
* [GET /api/coupon/{coupon-id}](#get-apicouponcoupon-id)
* [DELETE /api/coupon/{coupon-id}](#delete-apicouponcoupon-id)
* [Project Management](#project-management)
* [POST /api/project](#post-apiproject)
* [GET /api/project/{project-id}](#get-apiprojectproject-id)
* [PUT /api/project/{project-id}](#put-apiprojectproject-id)
* [DELETE /api/project/{project-id}](#delete-apiprojectproject-id)
* [POST /api/project/{project}/apikey](#post-apiprojectprojectapikey)
* [DELETE /api/project/{project}/apikey/{name}](#delete-apiprojectprojectapikeyname)
* [GET /api/project/{project-id}/usage](#get-apiprojectproject-idusage)
* [GET /api/project/{project-id}/limit](#get-apiprojectproject-idlimit)
* [Update limits](#update-limits)
* [POST /api/project/{project-id}/limit?usage={value}](#post-apiprojectproject-idlimitusagevalue)
* [POST /api/project/{project-id}/limit?bandwidth={value}](#post-apiprojectproject-idlimitbandwidthvalue)
* [POST /api/project/{project-id}/limit?rate={value}](#post-apiprojectproject-idlimitratevalue)
* [POST /api/project/{project-id}/limit?buckets={value}](#post-apiprojectproject-idlimitbucketsvalue)
* [APIKey Management](#apikey-management)
* [DELETE /api/apikey/{apikey}](#delete-apiapikeyapikey)
<!-- tocstop -->
## User Management
### POST /api/user