diff --git a/docs/README.md b/docs/README.md index d0940c4..c5e7adc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,6 +12,7 @@ __(ND)__ -> Not designed yet. - [X] `/verify` - [X] `/authenticate` - [X] `/delete` + - [ ] `/id` - [X] `/tokens` - [X] `/tokens` - [ ] `/follows` diff --git a/docs/account/id.md b/docs/account/id.md new file mode 100644 index 0000000..91d193f --- /dev/null +++ b/docs/account/id.md @@ -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. \ No newline at end of file diff --git a/docs/project/create.md b/docs/project/create.md index a6cb089..08f9040 100644 --- a/docs/project/create.md +++ b/docs/project/create.md @@ -22,7 +22,7 @@ __Content - JSON:__ ### 400 - Error: Bad Request The request was malformed. ### 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 Blocked for security reasons. ### 409 - Error: Conflict