[30k]: GET opportunities endpoint

[widal001]

Key links

• Deliverable specification
• Simpler Grants.gov full roadmap
• 10k milestones

Description

• What: Deploy a public API endpoint that allows system-to-system users to access basic information about each opportunity currently listed on grants.gov
• Why: Build iteratively, validate connection to the database, and set the groundwork to continue to enhance the API.
• Who
  • Internal development team
  • Subset of system-to-system users

Note

For more information about this deliverable please refer to the deliverable specification linked above

[sumiat]

The API has been load tested using the framework established in the Peformance Testing Framework deliverable to ensure that it remains performant under heavy user traffic

• will be completed in this effort: [Task]: Artillery.io for performance testing #647

Logging/monitoring is configured, and it both records the metrics defined below and alerts the development team when the API is down or other key monitoring thresholds are met (e.g. frequency of 4xx requests, response times, etc.)

• will be completed through security work [Task] Respond to log failures #878 and [Task]: Create Alert for Errors in API Application Logs #1033

The chosen API URL sub-domain has been secured for future deployment of the API and we've contacted the teams working on the existing service (if any) that is currently accessed through this sub-domain
API is live in prod URL

• will be completed by [Task]: Setup Production API URL #906

[EOKENAVA]

Weekly Update

What has been done?

• Finalize set up data replication peering connection on Simpler's side
• Finalize setup data replication user in Grant’s production database
• Finalize setup data replication peering connection on Grants’s side
• Created foreign data wrapper and test data access through on Prod
• Approval from MH to access prod
• We now have production data flowing all the way to API prod

Status
2/20/24 for connection to prod data (due to unexpected roadblocks it was decided that the 2/20 date for Get Opportunities is not achievable.)
Updated Date - March 5th (On Track)

Risk
None

Deliverable Date
March 5th

What will be done?

• Getting production URL
• Set up back-end performance testing

[coilysiren]

#906 (comment) is the last remaining ticket here

[EOKENAVA]

Weekly Update

What has been done?

• Completed 99% of the GET Opportunities Endpoint 30K on time.
• Completed back-end performance testing

Status
Blocked | Updated Date: TBD (Blocked on needing a DNS change and production certificate from HHS)

Risk
Outside (HHS) dependency

Deliverable Date
March 5th (Delayed)

What will be done?

• Need DNS change and production certificate from HHS.
• Getting production URL

[sarahknoppA6]

@EOKENAVA can you also provide the date and update from the last correspondence with HHS about the URL, if any?

[acouch]

@sarahknoppA6 Tuesday afternoon.

[coilysiren]

#906 is now unblocked, and is now in progress

[coilysiren]

#906 is now done, I believe this completes the 30k

[acouch]

Weekly Update

What has been done?

• Completed 99% of the GET Opportunities Endpoint 30K
• Completed API production URL, it is now available at: https://api.simpler.grants.gov/docs

Status
In progress

Risk
None

Deliverable Date
March 26th (Delayed)

What will be done?

• [Task]: Our desired project metrics are captured and displayed in a public place #1484

[sarahknoppA6]

@EOKENAVA @margaretspring @acouch The GET Opportunities endpoint 30k cannot be considered completed until the metrics are captured and published in a public place. cc @lucasmbrown-usds

[coilysiren]

@sarahknoppA6 apologies, we never made tickets for that. It looks like the 30k isn't done yet, we'll continue working on it.

[coilysiren]

Here is the metrics ticket: #1484

[margaretspring]

Weekly Update

What has been done?

• Scope change was requested. Initially the proposed metrics were to be captured in cloudwatch and documented in gitbook which was completed. The scope was expanded to request that the proposed metrics be posted publicly which has extended the completion date of the 30K.

• Met and confirmed plan for moving the GET Opportunities Metrics to a public location [Task]: Our desired project metrics are captured and displayed in a public place #1484 which is included in Sprint 20 which commenced March 20. This will complete the GET Opportunities Endpoint 30K.

Status
In progress

Risk
None

Deliverable Date
April 2(Extended)

What will be done?

• [Task]: Our desired project metrics are captured and displayed in a public place #1484

[margaretspring]

Weekly Update

What has been done?

• Got alignment on the metrics that are needed and how to document to meet the proposed metrics
• Added the spreadsheet and gitbook page

Status
In progress

Risk
None

Deliverable Date
4/2

What will be done?

• Design/Runbook workflow (where data can be found in CloudWatch) to updated to the spreadsheet on a sprint cadence
• Update the gitbook page started to include this workflow
• Share out the metrics page!

[sarahknoppA6]

Can we confirm where the metrics will be shared?

[sumiat]

yeah, we'll make sure to update in #1484 and share it in our next updates

[sarahknoppA6]

Is this still on track for completion tomorrow? I checked the ticket referenced above and I was a little unclear about the status. cc @lucasmbrown-usds

[acouch]

Weekly Update

Work has been completed.

What has been done?

#1484 has been completed.

Status
Completed

Risk
None

Deliverable Date
4/2

[margaretspring]

@sarahknoppA6 @widal001 - Is there a review process for closing this 30K? Please advise where/when this is done. Thank you!

[sarahknoppA6]

@margaretspring we typically schedule a meeting for 30k closeout. Could we use the first 5 mins of our 30k review meeting tomorrow to do this?

[widal001]

This was closed in the 30k review session on 4/11, with the following update to the deliverable spec marking it as "Done"

[widal001]

Updated the format of this ticket to reduce discrepancies between the GitHub issue and the deliverable spec.