-
Notifications
You must be signed in to change notification settings - Fork 56
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 simple API to access locations of adopted drains #236
Comments
I'll make a REST API for this purpose. I'd think we'd need some sort of authentication, as that is the standard for most public APIs. |
@jafowler49 Thanks! Yeah, I didn't mean to imply no authentication, just that we can keep it simple since we won't have to have multiple levels of access. For a first iteration, we can probably just assign access to those with admin roles and use basic authentication over TLS (the server has a ssl certificate). If we get a basic endpoint, then DataSF could just leverage our automation platform to pick up and sync the data to the open data portal. Access to data, including handling load is handled then by the vendor of the open data platform. Let me know if you have any questions. |
👍 I think using user authentication will be the simplest for now (we can introduce the concept of other authentication mechanisms like API tokens later if needed). Pagination will probably be a must for this given the size of the data. |
pull request for this feature opened @ #241 thanks! |
Use case: users want to have ad hoc access to what specific drains are adopted so they can map them or integrate them with other data.
Proposed acceptance criteria
Notes
Trying to keep this as narrowly scoped as possible to be simple but still useful. We could do other api methods, but this seems to be a valuable export option that doesn't introduce complex authentication scenarios.
cc/ @jeanwalshie @jafowler49 @jszwedko
The text was updated successfully, but these errors were encountered: