Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create APIs for address risk #128

Closed
3 tasks done
elucherini opened this issue Dec 23, 2024 · 0 comments
Closed
3 tasks done

Create APIs for address risk #128

elucherini opened this issue Dec 23, 2024 · 0 comments
Assignees
Labels

Comments

@elucherini
Copy link
Collaborator

elucherini commented Dec 23, 2024

Context

For the MVP, we need to support this user flow:

  1. User searches an address through search box.
  2. User gets back risk(s) for that address.

This is the backend issue for this user flow. We should also open a corresponding frontend issue, if it doesn't already exist.

Definition of Done

Three APIs with related tests:

  • API that, given an address, tells whether it is a soft story
  • API that, given an address, tells whether it is in a liquefaction seismic zone
  • API that, given an address, tells whether it is in a zone at risk of tsunami

Translating the address obtained through MapBox autocomplete into a geometrical Point could be handled by the frontend (so we keep all MapBox-related stuff in the frontend), so it is currently out of scope for this issue.

Engineering Details

All these APIs are GET requests that take latitude and longitude as input. The exact output should be further discussed with the frontend team. For now, all APIs return a simple boolean.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant