docs(api): defined and designed /account/id

This commit is contained in:
antifallobst 2023-09-10 13:44:51 +02:00
parent ed758d42d7
commit 2d7d66bed4
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
3 changed files with 21 additions and 1 deletions

View File

@ -12,6 +12,7 @@ __(ND)__ -> Not designed yet.
- [X] `/verify` - [X] `/verify`
- [X] `/authenticate` - [X] `/authenticate`
- [X] `/delete` - [X] `/delete`
- [ ] `/id`
- [X] `/tokens` - [X] `/tokens`
- [X] `/tokens` - [X] `/tokens`
- [ ] `/follows` - [ ] `/follows`

19
docs/account/id.md Normal file
View File

@ -0,0 +1,19 @@
# `/account/id` - GET
Returns identity information about the authorized account.
## HTTP Headers
| Header | Content |
|---------------|--------------------|
| Authorization | `Bearer {token}` |
## Responses
### 200 - Success
__Content - JSON:__
| Field | Description |
|----------|---------------------------|
| id | The accounts unique id. |
| username | The projects unique name. |
### 401 - Error: Unauthorized
The provided access token doesn't allow you to perform this operation.

View File

@ -22,7 +22,7 @@ __Content - JSON:__
### 400 - Error: Bad Request ### 400 - Error: Bad Request
The request was malformed. The request was malformed.
### 401 - Error: Unauthorized ### 401 - Error: Unauthorized
The provided access token doesn't allow you to perfrom this operation. The provided access token doesn't allow you to perform this operation.
### 403 - Error: Forbidden ### 403 - Error: Forbidden
Blocked for security reasons. Blocked for security reasons.
### 409 - Error: Conflict ### 409 - Error: Conflict