Document Lizardboard API(Closes #42) #44
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Moniarchy
commented
Nov 18, 2016
Moniarchy
commented
- Documented API and removed mongoose migrate from README
* Documented API and removed mongoose migrate from README
jrobcodes
suggested changes
Nov 18, 2016
Contributor
jrobcodes
left a comment
jrobcodes
left a comment
There was a problem hiding this comment.
@Moniarchy Changes requested inline
| - Ensure `mongo` is running | ||
| - yarn install | ||
|
|
||
| ## HTTP API |
Contributor
There was a problem hiding this comment.
Just API should be fine here
| ## HTTP API | ||
| description | CRUD | verb | path | | ||
| -------------------------------------------- | ------ | ------ | ---------------------------------------- | | ||
| Show all users | read | get | /api/v1/users | |
Contributor
There was a problem hiding this comment.
Kind of nitpicky, but the column title says CRUD, but then entries are listed in RC order here. Can you please order entries in this table consistently (in order CRUD)?
| Update user by ID | update | put | /api/v1/users/:id | | ||
| Delete user by ID | delete | delete | /api/v1/users/:id | | ||
| Show all dashboards | read | get | /api/v1/dashboards | | ||
| Create a dashboard | create | post | /api/v1/dashboards | |
Contributor
There was a problem hiding this comment.
For the Create and Update endpoints, we need to somehow list the expected data and data types, so that users of the API know what they are expected to post/put/etc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.