Api contract for users/userAvailble/:id route #20
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
saishankarmanugula
commented
Jan 28, 2021
saishankarmanugula
commented
added 6 commits
January 24, 2021 19:06
This reverts commit 1aa65be.
swarajpure
reviewed
Jan 29, 2021
users/README.md
Outdated
| Returns the availability of user name. | ||
|
|
||
| - **Params** | ||
| _Required:_ `id=[string]` |
users/README.md
Outdated
| @@ -111,6 +111,22 @@ Returns the specified user. | |||
| - **Code:** 401 | |||
| - **Content:** `{ 'statusCode': 401, 'error': 'Unauthorized', 'message': 'Unauthenticated User' }` | |||
|
|
|||
| ## **GET /users/userAvailable/:id** | |||
|
|
|||
| Returns the availability of user name. | |||
There was a problem hiding this comment.
Please combine and make it username
users/README.md
Outdated
| @@ -111,6 +111,22 @@ Returns the specified user. | |||
| - **Code:** 401 | |||
| - **Content:** `{ 'statusCode': 401, 'error': 'Unauthorized', 'message': 'Unauthenticated User' }` | |||
|
|
|||
| ## **GET /users/userAvailable/:id** | |||
There was a problem hiding this comment.
There should be username instead of id, right?
users/README.md
Outdated
| rds-session: `<JWT>` | ||
| - **Success Response:** | ||
| - **Code:** 200 | ||
| - **Content:** `{ 'userAvailable': <Availability Stauts> }` |
There was a problem hiding this comment.
Something like isUsernameAvailable sounds better to me. What do you say?
Also the value should be <boolean>
swarajpure
suggested changes
Feb 3, 2021
There was a problem hiding this comment.
Looks good to me 👍🏻
Also, if this route is going to require authentication (which I think it would), please add 4xx error response for unauthorized user
Also, kindly add 5xx error for server error response
You can refer contracts for other users routes to get idea of the above two error responses.
Thank you 🎉
ankushdharkar
approved these changes
Feb 21, 2021
|
This looks good. Thanks @saishankarmanugula! |
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.