docs(api): moved implementation status into API.md
This commit is contained in:
parent
c444f561b3
commit
9c36130955
22
API.md
22
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.
|
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
|
||||||
|
- `/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
|
## Endpoints
|
||||||
### `/account/register` - POST
|
### `/account/register` - POST
|
||||||
Requests a new nerdcult account.
|
Requests a new nerdcult account.
|
||||||
|
|
24
README.md
24
README.md
|
@ -11,26 +11,4 @@ export SMTP_HOST_URL=smtp.yourmailserver.tld
|
||||||
export SMTP_USER=accounts@yourdomain.tld
|
export SMTP_USER=accounts@yourdomain.tld
|
||||||
export SMTP_PASSWORD=password
|
export SMTP_PASSWORD=password
|
||||||
./nerdcult_api
|
./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
|
|
Loading…
Reference in New Issue