Fixup readme format?
parent
d10db5d31b
commit
8beea8b45e
25
README.md
25
README.md
|
@ -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",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue