docs(api): moved implementation status into API.md

This commit is contained in:
antifallobst 2023-08-18 16:41:56 +02:00
parent c444f561b3
commit 9c36130955
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
2 changed files with 23 additions and 23 deletions

22
API.md
View File

@ -3,6 +3,28 @@ All API endpoints are accessible with this base URL: `https://api.nerdcult.net/`
Some API endpoints require an Authorization HTTP header.
The token for this can be aquired using the `/account/authenticate` endpoint.
## Implementation Status
- `/account`
- [X] `/register` - POST
- [X] `/verify` - POST
- [X] `/authenticate` - POST
- [X] `/delete` - DELETE
- [X] `/tokens` - DELETE
- [X] `/tokens` - GET
- [ ] `/follows` - GET
- [ ] `/followers` - GET
- `/user/{username}`
- [ ] `/info` - GET
- [ ] `/follow` - POST
- [ ] `/follows` - GET
- [ ] `/followers` - GET
- [ ] `/projects` - GET
- `/project`
- [ ] `/create` - POST
- `/{projectname}`
- [ ] `/info` - GET
- [ ] `/join` - POST
## Endpoints
### `/account/register` - POST
Requests a new nerdcult account.

View File

@ -11,26 +11,4 @@ export SMTP_HOST_URL=smtp.yourmailserver.tld
export SMTP_USER=accounts@yourdomain.tld
export SMTP_PASSWORD=password
./nerdcult_api
```
## Implementation Status
- `/account`
- [X] `/register` - POST
- [X] `/verify` - POST
- [X] `/authenticate` - POST
- [X] `/delete` - DELETE
- [X] `/tokens` - DELETE
- [X] `/tokens` - GET
- [ ] `/follows` - GET
- [ ] `/followers` - GET
- `/user/{username}`
- [ ] `/info` - GET
- [ ] `/follow` - POST
- [ ] `/follows` - GET
- [ ] `/followers` - GET
- [ ] `/projects` - GET
- `/project`
- [ ] `/create` - POST
- `/{projectname}`
- [ ] `/info` - GET
- [ ] `/join` - POST
```