feat: add API to retrieve grant notes for specific user via Finder API #3471
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implemented `getOrganizationNotesForGrantByUser()` function in `grantsCollaboration/notes.js` - Renamed `getOrganizationNotesForGrant()` to `getCurrentNoteRevisions()` and updated signature - Made conditional `WHERE` clause for `grantId` and `userId` in `getCurrentNoteRevisions()` - Created API route `GET /:grantId/notes/user/:userId` in `grants.js` for fetching user-specific grant notes - Added validation for `afterRevision` and `limit` query parameters in the new API - Ensured results are paginated and ordered by `created_at` in descending order - Added necessary imports/exports in `grantsCollaboration/index.js`
github-actions
bot
added
enhancement
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
QA Summary
Test CoverageCoverage report for `packages/client`
Coverage report for `packages/server`
|
Terraform Summary
Hint: If "Terraform Format & Style" failed, run OutputValidation OutputPlan Summary
Pusher: @TylerHendrickson, Action: |
|
@sushilrajeeva is it possible to add test coverage for this new route? |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
TylerHendrickson
requested changes
Sep 11, 2024
There was a problem hiding this comment.
@sushilrajeeva Apologies for the premature approval – I missed checking the unit tests. Agree with @greg-adams' comment that it would be good for this new route to have test coverage.
| grantId, | ||
| { afterRevision, limit = 50 } = {}, | ||
| ) { | ||
| return getCurrentNoteRevisions(knex, { grantId, userId }, { afterRevision, limit }); |
There was a problem hiding this comment.
Per #3426 (comment):
Suggested change
| return getCurrentNoteRevisions(knex, { grantId, userId }, { afterRevision, limit }); | |
| return getCurrentNoteRevisions(knex, { grantId, organizationId, userId }, { afterRevision, limit }); |
7 tasks
…ific-user-FinderAPI
TylerHendrickson
approved these changes
Sep 24, 2024
sushilrajeeva
deleted the
sushilrajeeva/feat/retrieve-grant-notes-specific-user-FinderAPI
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket #3426
Description
This PR implements the ability to retrieve notes for a specific user and grant via the Finder API, addressing the requirements outlined in the issue #3426
Changes include :
getOrganizationNotesForGrantByUser()function ingrantsCollaboration/notes.jsgetOrganizationNotesForGrant()togetCurrentNoteRevisions()and updated signatureWHEREclause forgrantIdanduserIdingetCurrentNoteRevisions()GET /:grantId/notes/user/:userIdingrants.jsfor fetching user-specific grant notesafterRevisionandlimitquery parameters in the new APIcreated_atin descending ordergrantsCollaboration/index.jsFixes #3426
Screenshots / Demo Video
N/A
Testing
Automated and Unit Tests
Manual tests for Reviewer
Checklist