docs: improve some READMEs
This commit is contained in:
parent
6f69695758
commit
a4a750b35c
3 changed files with 49 additions and 2 deletions
21
public/api/users/:id/README.md
Normal file
21
public/api/users/:id/README.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# /api/users/:id
|
||||
|
||||
Interact with a specific user.
|
||||
|
||||
## GET /api/users/:id
|
||||
|
||||
Get the user specified by `:id`. (user match/admin)
|
||||
|
||||
## PUT /api/users/:id
|
||||
|
||||
Update the user specified by `:id`. (user match/admin)
|
||||
|
||||
```
|
||||
{
|
||||
username?: string; // update username
|
||||
}
|
||||
```
|
||||
|
||||
## DELETE /api/users/:id
|
||||
|
||||
Delete the user specified by `:id`. (user match/admin)
|
Loading…
Add table
Add a link
Reference in a new issue