[Issue #3295] Create GET /users/:userId/saved-opportunities API schema and stub endpoint #3355
Conversation
api/src/api/users/user_routes.py
Outdated
| } | ||
| ) | ||
|
|
||
| return {"message": "Success", "data": opportunities_data} |
There was a problem hiding this comment.
We shouldn't be returning a dict, return an ApiResponse object
api/src/api/users/user_routes.py
Outdated
| opportunities_data = [] | ||
| for saved in saved_opportunities: | ||
| opp = saved.opportunity | ||
| summary = opp.summary |
There was a problem hiding this comment.
This loop shouldn't be necessary, it should be fine to return the ORM objects and Marshmallow will handle iterating over/making them into JSON for you. If you're hitting an error about objects being detached from a session, then that's because SQLAlchemy lazy-loads all relationships (this loop effectively emits several SQL queries). Easiest way around that is to load in the query itself. It's why in an endpoint like GET opportunity we do .options(selectinload("*")): https://github.com/HHS/simpler-grants-gov/blob/main/api/src/services/opportunities_v1/get_opportunity.py#L21
There was a problem hiding this comment.
Yep that makes sense. I thought we had to do more work here than needed. I did update the utility to return pure Opportunity objects so it will fit in the shape of the response.
Co-authored-by: Michael Chouinard <[email protected]>
Co-authored-by: Michael Chouinard <[email protected]>
…s://github.com/HHS/simpler-grants-gov into mikehgrantsgov/3295-create-get-user-saved-opps
Co-authored-by: Michael Chouinard <[email protected]>
…s://github.com/HHS/simpler-grants-gov into mikehgrantsgov/3295-create-get-user-saved-opps
Summary
Fixes #3295
Time to review: 25 mins
Changes proposed
Create GET /users/:userId/saved-opportunities API schema
Context for reviewers
Overlaps with the implementation ticket, as it was easier to add the service and implementation vs. stub + implement in 2 different PRs
Additional information
See attached unit tests.