Improve documentation
This commit is contained in:
parent
db1b48ee02
commit
1df6899472
1 changed files with 6 additions and 5 deletions
11
README.md
11
README.md
|
@ -3,8 +3,9 @@
|
|||
Base url = `https://corder.tech`
|
||||
|
||||
|
||||
| Endpoint | Return |
|
||||
| ------------------------ | ------------------------------ |
|
||||
| `/mocha/users/{user_id}` | row with the given user |
|
||||
| `/mocha/users/*` | all rows |
|
||||
| `/mocha/top/{n}` | user with the n highest scores |
|
||||
| Endpoint | Return | Implemented? |
|
||||
| ---------------------------------- | ------------------------------ | ------------ |
|
||||
| `/mocha/users/{user_id}` | row with the given user | Yes |
|
||||
| `/mocha/users/*` | all rows | Yes |
|
||||
| `/mocha/top/{n}` | user with the n highest scores | No |
|
||||
| `/mocha/set/{user_id}/{num_steps}` | 200 OK if successful | No |
|
||||
|
|
Reference in a new issue