2962: CAN Summary Card - update funding summary endpoint #3075
Conversation
maiyerlee
changed the title
maiyerlee
force-pushed
the
OPS-2962-update-CAN-summary-endpoint
branch
from
eaca2c4 to
b7f1898
Compare
maiyerlee
requested review from
johndeange,
rajohnson90,
fpigeonjr and
Santi-3rd
| @@ -172,7 +172,7 @@ def register_api(api_bp: Blueprint) -> None: | |||
| ) | |||
|
|
|||
| api_bp.add_url_rule( | |||
| "/can-funding-summary/<int:id>", | |||
There was a problem hiding this comment.
The endpoints for *ITEM_API_VIEW* are designed to take an resource id, e.g. <int:id> while the *LIST_API_VIEW does not. It would be more consistent if /can-funding-summary/ used CAN_FUNDING_RECEIVED_LIST_API_VIEW_FUNC.
There was a problem hiding this comment.
Great catch! I changed the view name to CAN_FUNDING_SUMMARY_LIST_API_VIEW_FUNC.
|
|
||
| # Check if required 'can_ids' parameter is provided | ||
| if not can_ids: | ||
| return make_response_with_headers({"error": "'can_ids' parameter is required"}, 400) |
There was a problem hiding this comment.
The above request.args handling and can_ids validation would be better in a Marshmallow schema but it would be acceptable to take that as a tech debt item if you don't have time to implement it.
| @@ -87,15 +108,109 @@ def get_can_funding_summary(can: CAN, fiscal_year: Optional[int] = None) -> CanF | |||
| available_funding = total_funding - sum([planned_funding, obligated_funding, in_execution_funding]) or 0 | |||
|
|
|||
| return { | |||
| "can": can.to_dict(), | |||
There was a problem hiding this comment.
Would be better as a Marshmallow schema for the response but OK as tech debt.
There was a problem hiding this comment.
I added the items below to avoid tech debt:
- request and response Marshmallow schemas
- new service for can funding summary
* fix: ops api url for funding sums * refactor: be logic * feat: apply fy to filter
| inExecutionFunding={fundingSummaryData?.in_execution_funding} | ||
| />} | ||
| /> | ||
| <DebugCode |
There was a problem hiding this comment.
👀 let's remove this before merging in
* feat: api integration is updating CAN List cards * chore: cleanup
|
🎉 This PR is included in version 1.8.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
What changed
Endpoint
/api/v1/can-funding-summarychanges:new_funding,in_draft_fundingFront-end (FE) changes:
Issues
Update CAN Funding summary endpoint #2962
Add DRAFT budget lines to /can-funding-summary response #3070
How to test
Ensure all unit and E2E tests are passing.
Screenshots
N/A
Definition of Done Checklist
- [ ] Form validations updatedLinks
New Funding