zkitter/groups
1
0
Fork 0
mirror of https://github.com/zkitter/groups.git synced 2026-01-09 13:08:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
r1oga
2023-01-31 23:03:37 +01:00
committed by GitHub
parent 55e55ae111
commit 2b062ba78a
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -12,7 +12,7 @@ Under the hood, it:
| METHOD | PATH | DESCRIPTION | RESPONSE |
| ------ | ------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| GET | `/whitelist` | Get list of whitelisted organizations | `Array<{ followers: number, followers7d?: number, snapshotId: string, snapshotName: string, ghName: string, repos: string[] }>` |
| GET | `/whitelist?format=short\|long` | Get list of whitelisted organizations in `short` or `long` format | `Array<{ followers: number, followers7d?: number, snapshotId: string, snapshotName: string, ghName: string, repos: string[] }>` |
| GET | `/whitelist/refresh` | Update list of whitelisted orgs and their repos. Return updated whitelist | `Array<{ followers: number, followers7d?: number, snapshotId: string, snapshotName: string, ghName: string, repos: string[] }>` |
| GET | `/user/:username` | Get groups a user is part of | `{ belongsToGhContributorsGroup: boolean, belongsToDaoVotersGroups: boolean }` |
| GET | `/user/:username/refresh` | Update list of repos a user contributed to and return updated user | `{ ghName: string, repos: string[]}` |
| GET | `/user/:username?format=short\|long` | Get user `username` in `short` (only groups info) or `long` (with repos) format | `{ belongsToGhContributorsGroup: boolean, belongsToDaoVotersGroups: boolean }` |
| GET | `/user/:username/refresh` | Update list of repos the user `username` contributed to and return updated user | `{ ghName: string, repos: string[]}` |