Skip to content

Commit 5dbd000

Browse files
authored
Merge pull request #174 from Real-Dev-Squad/feat/github_user_id
Doc : listed github_user_id in user model
2 parents b91a983 + 556dcd4 commit 5dbd000

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

users/README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
'designation': string,
1616
'img': string,
1717
'github_id': string,
18+
'github_user_id': string,
1819
'linkedin_id': string,
1920
'twitter_id': string,
2021
'instagram_id': string,
@@ -322,7 +323,7 @@ Archive users if not in Discord.
322323

323324
```json
324325
{
325-
"action": "nonVerifiedDiscordUsers | archiveUsers"
326+
"action": "nonVerifiedDiscordUsers | archiveUsers"
326327
}
327328
```
328329

@@ -332,27 +333,27 @@ Archive users if not in Discord.
332333

333334
```json
334335
{
335-
"message": "Successfully updated users archived role to true if in_discord role is false | Couldn't find any users currently inactive in Discord but not archived.",
336-
"data": {
337-
"totalUsers": "number",
338-
"totalUsersArchived": "number",
339-
"totalOperationsFailed": "number"
340-
}
336+
"message": "Successfully updated users archived role to true if in_discord role is false | Couldn't find any users currently inactive in Discord but not archived.",
337+
"data": {
338+
"totalUsers": "number",
339+
"totalUsersArchived": "number",
340+
"totalOperationsFailed": "number"
341+
}
341342
}
342343
```
343344

344345
**Addition info if debug query is set to true**
345346

346347
```json
347348
{
348-
"message": "Successfully updated users archived role to true if in_discord role is false | Couldn't find any users currently inactive in Discord but not archived.",
349-
"data": {
350-
"totalUsers": "number",
351-
"totalUsersArchived": "number",
352-
"totalOperationsFailed": "number",
353-
"updatedUserDetails": "array",
354-
"failedUserDetails": "array"
355-
}
349+
"message": "Successfully updated users archived role to true if in_discord role is false | Couldn't find any users currently inactive in Discord but not archived.",
350+
"data": {
351+
"totalUsers": "number",
352+
"totalUsersArchived": "number",
353+
"totalOperationsFailed": "number",
354+
"updatedUserDetails": "array",
355+
"failedUserDetails": "array"
356+
}
356357
}
357358
```
358359

@@ -364,9 +365,9 @@ Archive users if not in Discord.
364365

365366
```json
366367
{
367-
"statusCode": 401,
368-
"error": "Unauthorized",
369-
"message": "Unauthenticated User"
368+
"statusCode": 401,
369+
"error": "Unauthorized",
370+
"message": "Unauthenticated User"
370371
}
371372
```
372373

@@ -376,9 +377,9 @@ Archive users if not in Discord.
376377

377378
```json
378379
{
379-
"statusCode": 400,
380-
"error": "Bad Request",
381-
"message": "Invalid payload"
380+
"statusCode": 400,
381+
"error": "Bad Request",
382+
"message": "Invalid payload"
382383
}
383384
```
384385

@@ -388,8 +389,8 @@ Archive users if not in Discord.
388389

389390
```json
390391
{
391-
"statusCode": 500,
392-
"error": "Internal Server Error",
393-
"message": "An internal server error occurred"
392+
"statusCode": 500,
393+
"error": "Internal Server Error",
394+
"message": "An internal server error occurred"
394395
}
395396
```

0 commit comments

Comments
 (0)