Releases: codeforamerica/ohana-api
0.3.1.0 (Admin interface)
This release adds an admin interface to the app. It includes enhancements over the standalone admin interface and is recommended over the standalone app.
Make sure to run rake db:migrate
after pulling the source code.
The admin interface can be accessed by visiting the /admin
path and signing in with one of the three admin users defined in db/seeds.rb. To set an admin as a super admin, see the last section in INSTALL.md for instructions.
Notable workflow changes (compared to the standalone app):
- When a regular admin signs in, they will see 2 buttons that they can click to see the Organizations and Locations they have access to.
- Super admins will have 2 additional buttons to create an Organization or a Location.
- Only super admins can create a new Organization.
- Regular admins can create a new location for the Organizations they have access to. The "Add a new location" button will appear in the
/admin/locations
path for regular admins. - Admins can now view, edit, and create multiple services for each location. To view the services that exist for a location, go to the location, then scroll down to the Services section at the bottom. From there, an admin can view or create a Service.
Notable data validation changes:
- The name and description attributes of a Service are now required.
New setting added to settings.example.yml:
- admin_support_email: This is the email address that is linked to from an admin's
admin/locations
andadmin/organizations
path and is the email address that admins should send questions or report issues to. Please make sure you set an appropriate email address so that admins can contact you.
New text customizations added to en.yml:
- You can now customize the brand name of the app. By default, it's "Ohana API", but you might want to make it more specific to your community.
Heroku deployment:
Note that if you've already deployed the API app to Heroku, you will need to run heroku run rake db:migrate
after pushing this release to Heroku
0.3.0.0 (Rails + Active Model Serializers)
This release moves the API out of the Grape framework and into Rails controllers with Active Model Serializers.
Notable changes:
- The API now returns attributes whose values are nil or empty
- Search now returns a much smaller response since most clients won't need every table in the DB, which is what it used to return.
- After creating a new location, the response now only sends back the id, name, and slug in the JSON, along with a
Location
HTTP header with the URL to the new location. That should be all an admin client would need. - Added support for API subdomains, to allow you to host your API at http://api.domain.org instead of http://domain.org/api
- Added support for developer subdomains, to allow you to host your developer portal at http://developer.domain.org
- Added ENV vars to configure subdomains and/or paths for the API and developer portal (see application.example.yml)
- Added ENV vars to configure pagination settings (DEFAULT_PER_PAGE and MAX_PER_PAGE) (see application.example.yml)
- Removed Swagger documentation because it was tied to the API implementation and not portable to Rails controllers. I'm thinking a static site with Markdown files would be the way to go.
- Validation errors now return 422 instead of 400
Please read through the installation instructions to make sure you have everything configured correctly.
0.2.0.0 (Postgres version of API)
v2.0.0 replaces MongoDB with Postgres and upgrades Rails from 3.2.17 to 4.0.4
Make sure to go through the README for new installation and deployment instructions.