diff --git a/docs/README.md b/docs/README.md index fd33a5e..191f5d6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,12 @@ Some API endpoints require an Authorization HTTP header. The token for this can be aquired using the `/account/authenticate` endpoint. ## Implementation Status +| Status | Explanation | +|--------|-------------------------------------| +| [X] | Implemented and documented. | +| [ ] | Documented but not implemented yet. | +| (ND) | Not documented yet. | + - `/account` - [X] `/register` - [X] `/verify` @@ -25,6 +31,20 @@ The token for this can be aquired using the `/account/authenticate` endpoint. - [X] `/create` - [ ] `/info` - [ ] `/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 An example _Register -> Verify -> Authenticate -> Delete_ flow. @@ -143,4 +163,4 @@ Strict-Transport-Security: max-age=31536000; includeSubDomains ## TODO - Password checking on registration -- account bound rate limit \ No newline at end of file +- account bound rate limit