docs(api): defined vault and backup endpoints
This commit is contained in:
parent
12aa9d3146
commit
80460dfea3
|
@ -4,6 +4,12 @@ Some API endpoints require an Authorization HTTP header.
|
||||||
The token for this can be aquired using the `/account/authenticate` endpoint.
|
The token for this can be aquired using the `/account/authenticate` endpoint.
|
||||||
|
|
||||||
## Implementation Status
|
## Implementation Status
|
||||||
|
| Status | Explanation |
|
||||||
|
|--------|-------------------------------------|
|
||||||
|
| [X] | Implemented and documented. |
|
||||||
|
| [ ] | Documented but not implemented yet. |
|
||||||
|
| (ND) | Not documented yet. |
|
||||||
|
|
||||||
- `/account`
|
- `/account`
|
||||||
- [X] `/register`
|
- [X] `/register`
|
||||||
- [X] `/verify`
|
- [X] `/verify`
|
||||||
|
@ -25,6 +31,20 @@ The token for this can be aquired using the `/account/authenticate` endpoint.
|
||||||
- [X] `/create`
|
- [X] `/create`
|
||||||
- [ ] `/info`
|
- [ ] `/info`
|
||||||
- [ ] `/join`
|
- [ ] `/join`
|
||||||
|
- `/vault`
|
||||||
|
- [ ] `/info` (ND)
|
||||||
|
- [ ] `/key` (ND)
|
||||||
|
- `/fs`
|
||||||
|
- [ ] `/create` (ND)
|
||||||
|
- [ ] `/read` (ND)
|
||||||
|
- [ ] `/write` (ND)
|
||||||
|
- [ ] `/info` (ND)
|
||||||
|
- [ ] `/delete` (ND)
|
||||||
|
- `/admin`
|
||||||
|
- `/backup`
|
||||||
|
- [ ] `/list` (ND)
|
||||||
|
- [ ] `/fetch/{id}` (ND)
|
||||||
|
- [ ] `/create` (ND)
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
An example _Register -> Verify -> Authenticate -> Delete_ flow.
|
An example _Register -> Verify -> Authenticate -> Delete_ flow.
|
||||||
|
@ -143,4 +163,4 @@ Strict-Transport-Security: max-age=31536000; includeSubDomains
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
- Password checking on registration
|
- Password checking on registration
|
||||||
- account bound rate limit
|
- account bound rate limit
|
||||||
|
|
Loading…
Reference in New Issue