diff --git a/docs/README.md b/docs/README.md index 93a6737..ac8fc61 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,6 +26,7 @@ __(ND)__ -> Not designed yet. - [ ] `/projects` - `/project` - [X] `/create` + - [ ] `/delete` - [X] `/info` - [ ] `/join` - `/vault` diff --git a/docs/project/delete.md b/docs/project/delete.md new file mode 100644 index 0000000..91accec --- /dev/null +++ b/docs/project/delete.md @@ -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. \ No newline at end of file