docs(api): defined and designed /project/delete

This commit is contained in:
antifallobst 2023-09-10 02:16:06 +02:00
parent 6f7c7fe15b
commit e93d8675c4
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
2 changed files with 27 additions and 0 deletions

View File

@ -26,6 +26,7 @@ __(ND)__ -> Not designed yet.
- [ ] `/projects` - [ ] `/projects`
- `/project` - `/project`
- [X] `/create` - [X] `/create`
- [ ] `/delete`
- [X] `/info` - [X] `/info`
- [ ] `/join` - [ ] `/join`
- `/vault` - `/vault`

26
docs/project/delete.md Normal file
View File

@ -0,0 +1,26 @@
# `/project/delete` - DELETE
Deletes a project.
## HTTP Headers
| Header | Content |
|---------------|--------------------|
| Authorization | `Bearer {token}` |
## Urlencoded Parameters
You have to set one parameter.
Setting none or two parameters will result in a _400 Bad Request_ Response.
| Parameter | Description |
|-----------|--------------------|
| name | The projects name. |
| id | The projects id. |
## Responses
### 200 - Success
Successfully deleted the project.
### 400 - Error: Bad Request
The request was malformed.
### 401 - Error: Unauthorized
The provided access token doesn't allow you to perform this operation.
### 403 - Error: Forbidden
Blocked for security reasons.