codeforamerica / ohana-api

The open source API directory of community social services.
http://ohana-api-demo.herokuapp.com/api
BSD 3-Clause "New" or "Revised" License
185 stars 344 forks source link

Update API and Admin interface to support fields defined in the OpenReferral spec. #236

Closed monfresh closed 9 years ago

monfresh commented 9 years ago

This should really only be done once version 1.0 of the spec is released, which is currently scheduled for January 5, 2015. However, I have started pulling in some fields that I think are not likely to change. You can follow the progress in this PR: https://github.com/codeforamerica/ohana-api/pull/235

The spec is currently at v0.2, and if there are any changes between v0.2 and 1.0, they will not be incorporated in the API until v1.0 because it does not make sense to keep changing the API while the spec hasn't been finalized.

monfresh commented 9 years ago

This is about halfway done now, and PR #235 has been merged into master. The remaining tables that need to be updated are:

The Metadata table will not be supported as it is currently out of scope. We tried to implement such a change tracker, but realized it was a lot more complicated than we originally thought. See PR #191 for more details.

monfresh commented 9 years ago

Programs have been added today. The schedules tables are the only ones remaining, but note that the API still supports the text-based hours field. My guess is that most of the people who will be importing data into the API have hours of operation listed as a String in one flat field. That means that the API technically supports all the fields from HSDS now.

monfresh commented 9 years ago

Regular Schedules are now available.

monfresh commented 9 years ago

Holiday Schedules can now be imported into the DB. Admin interface support following shortly.

monfresh commented 9 years ago

This is now complete, based on the tables and fields from version 0.4 of the spec that are not still under discussion. The following fields, tables and relationships are still being discussed and therefore are not present in the API:

monfresh commented 9 years ago

Completed with #309 and #310.