From 9c361309554e828093a24e5cd5b00dcf0af80fba Mon Sep 17 00:00:00 2001 From: antifallobst Date: Fri, 18 Aug 2023 16:41:56 +0200 Subject: [PATCH] docs(api): moved implementation status into API.md --- API.md | 22 ++++++++++++++++++++++ README.md | 24 +----------------------- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/API.md b/API.md index edc7acb..06e952f 100644 --- a/API.md +++ b/API.md @@ -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. diff --git a/README.md b/README.md index 5e13a17..cd37942 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file +``` \ No newline at end of file