Skip to content

fix: Route Description table for Users contract #232

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: Route Description table for Users contract #232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1698b65
fixed route-description table for users contract
Suvidh-kaushik Apr 30, 2025
974e9ea
fixed naming inconsistencies
Suvidh-kaushik Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions users/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,21 @@ number and email address.

## **Requests**

| Route | Description |
| :----------------------------------------------------: | :--------------------------------------: |
| [GET /users](#get-users) | Returns all users in the system |
| [GET /users/self](#get-usersSelf) | Returns the logged in user's details |
| [GET /users/userId/:userId](#get-usersuseriduserid) | Returns user with given userId |
| [GET /users/:username](#get-usersusername) | Returns user with given username |
| [GET /users/:userId/badges](#get-usersidbadges) | Returns badges assigned to the user |
| [GET /users/search](#get-users-search) | Returns users based on specified filters |
| [POST /users](#post-users) | Creates a new User |
| [PATCH /users/self](#patch-usersself) | Updates data of the User |
| [PATCH /users/:id/temporary/data](#patch-usersidroles) | Updates user roles |
| [PATCH /users](#patch-users) | Archive users if not in discord |
| Route | Description |
| :------------------------------------------------------------: | :---------------------------------------------: |
| [GET /users](#get-users) | Returns all users in the system |
| [GET /users/self](#get-usersself) | Returns the logged-in user's details |
| [GET /users/userId/:userId](#get-usersuseriduserid) | Returns user with given userId |
| [GET /users/:username](#get-usersusername) | Returns user with given username |
| [GET /users/:userId/badges](#get-usersidbadges) | Returns badges assigned to the user |
| [GET /users/search](#get-userssearch) | Returns users based on specified filters |
| [POST /users](#post-users) | Creates a new User |
| [PATCH /users/self](#patch-usersself-to-be-deprecated) | Updates data of the User |
| [PATCH /users/:id/temporary/data](#patch-usersidtemporarydata) | Updates user roles |
| [PATCH /users](#patch-users) | Archive users if not in discord |
| [PUT /users/:userId/intro](#put-usersuseridintro) | Create a User Intro in DB if not present |
| [PATCH /users/:userId](#patch-usersuserid) | Allows super users to approve profile diffs |
| [PATCH /users/:userId](#patch-usersuserid) |Allows authenticated users to update profile data|
Copy link
Member

Choose a reason for hiding this comment

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

PATCH /users/:userId is listed twice—should we clarify roles or merge into one row with both use cases?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes it is used for 2 things so added it twice , adding both in the same row will increase table width that's why i did not prefer that


## **GET /users**

Expand Down