diff --git a/README.md b/README.md index 59f78af..a4a4298 100644 --- a/README.md +++ b/README.md @@ -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[]}` |