Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Api contract for users/userAvailble/:id route #20

Merged
merged 12 commits into from Feb 21, 2021
Merged

Api contract for users/userAvailble/:id route #20

Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b3cb58b
added api-contract for users/userAvailable/:username
Jan 24, 2021
1aa65be
api-contract for users/userAvailable/:id path
Jan 28, 2021
7273c8d
Revert "api-contract for users/userAvailable/:id path"
Jan 28, 2021
ba3dc2f
Merge branch 'main' of https://github.com/Real-Dev-Squad/website-api-…
Jan 28, 2021
2c44835
api contract for users/userAvailable/:id route
Jan 28, 2021
f022f2e
api contract for users/userAvailable/:id route
Jan 28, 2021
23780b0
api-contract for users/isUsernameAvailable/:username route
Feb 3, 2021
766e60e
Merge branch 'main' of https://github.com/Real-Dev-Squad/website-api-…
Feb 3, 2021
d3b9ee7
Merge branch 'pr140' into main
Feb 3, 2021
19c3c0b
Merge branch 'main' of https://github.com/Real-Dev-Squad/website-api-…
Feb 21, 2021
ef71f1b
added 40x, 50x error codes documentation
Feb 21, 2021
3450580
Merge branch 'pr140' into main
Feb 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions users/README.md
View file
Open in desktop
Expand Up @@ -111,6 +111,22 @@ Returns the specified user.
- **Code:** 401
- **Content:** `{ 'statusCode': 401, 'error': 'Unauthorized', 'message': 'Unauthenticated User' }`

## **GET /users/userAvailable/:id**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be username instead of id, right?


Returns the availability of user name.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please combine and make it username


- **Params**
_Required:_ `id=[string]`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re: id

- **Body**
None
- **Headers**
Content-Type: application/json
- **Cookie**
rds-session: `<JWT>`
- **Success Response:**
- **Code:** 200
- **Content:** `{ 'userAvailable': <Availability Stauts> }`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like isUsernameAvailable sounds better to me. What do you say?
Also the value should be <boolean>


## **POST /users**

Creates a new User.
Expand Down