Updated the order of the response (message followed by data) #10
Conversation
This file contains 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
maheshwarigagan
approved these changes
Sep 11, 2019
MichaelCurrin
suggested changes
Aug 20, 2020
| @@ -6,8 +6,8 @@ All responses will have the form | |||
|
|
|||
| ```json | |||
| { | |||
| "data": "Mixed type holding the content of the response", | |||
| "message": "Description of what happened" | |||
There was a problem hiding this comment.
JSON data does not have guaranteed order for a keys
Also the comma is on the wrong one so the syntax is invalid now.
MichaelCurrin
suggested changes
Aug 20, 2020
| @@ -58,6 +58,7 @@ If a device with the given identifier already exists, the existing device will b | |||
| **Response** | |||
|
|
|||
| - `201 Created` on success | |||
| - `400 BAD REQUEST` on plure due to incorrect data | |||
There was a problem hiding this comment.
What's a plure?
Also "Bad Request" would be better to match the case of the 201.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated the README to reflect the correct order of the response :)