From 1698b6578fd4c91b32fbed2033d88a9661cbf334 Mon Sep 17 00:00:00 2001 From: suvidh Date: Thu, 1 May 2025 01:21:02 +0530 Subject: [PATCH 1/2] fixed route-description table for users contract --- users/README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/users/README.md b/users/README.md index e21272a8..eb139572 100644 --- a/users/README.md +++ b/users/README.md @@ -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 diff | +| [PATCH /users/:userId](#patch-usersuserid) |Allows authenticated users to update profile data| ## **GET /users** From 974e9ea79b6aedae73c20de40697243760855c98 Mon Sep 17 00:00:00 2001 From: suvidh Date: Thu, 1 May 2025 01:38:05 +0530 Subject: [PATCH 2/2] fixed naming inconsistencies --- users/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/users/README.md b/users/README.md index eb139572..ed9f948c 100644 --- a/users/README.md +++ b/users/README.md @@ -40,7 +40,7 @@ number and email address. | 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/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 | @@ -50,7 +50,7 @@ number and email address. | [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 diff | +| [PATCH /users/:userId](#patch-usersuserid) | Allows super users to approve profile diffs | | [PATCH /users/:userId](#patch-usersuserid) |Allows authenticated users to update profile data| ## **GET /users**