Fixup readme format?

break-database
~erin 2021-07-23 11:29:42 -04:00
parent d10db5d31b
commit 8beea8b45e
Signed by: erin
GPG Key ID: DA70E064A8C70F44
1 changed files with 13 additions and 12 deletions

View File

@ -63,23 +63,24 @@ This API will return info about a user on success.
`GET /api/users/<name>` `GET /api/users/<name>`
On success returns JSON in format: On success returns JSON in format:
```
`status`: `ok` status: ok
`user`: user:
`name`: user's name name: user's name
`pronouns`: user's pronouns pronouns: user's pronouns
`role`: the users role, one of either `Normal`, `Moderator`, or `Admin role: the users role, one of either 'Normal', 'Moderator', or 'Admin'
```
eg: eg:
``` ```
{ {
status: "ok", status: "ok",
user: { user: {
name: "example", name: "example",
pronouns: "they/them", pronouns: "they/them",
role: "Normal", role: "Normal",
}, },
} }
``` ```