This is the working repository for Open Referral's Human Services Data API protocols.
HTML JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_includes
_layouts
_site
blog update base Jan 24, 2017
contact
css
hsda-bulk
hsda-management
hsda-meta
hsda-orchestration
hsda-search
hsda-taxonomy
hsda-utility
hsda-v1.1
hsda
js
.gitignore
LICENSE
README.md
_config.yml
apis.json
blog.xml
index.html

README.md

Open Referral Human Services Data API Specification

This project is driven by an OpenAPI definition located in _data/api-commons/openapi-hsda.yaml

The website for this repo can be found at: https://openreferral.github.io/api-specification/definition/

Here is the current road map for HSDA:

v1.1

  • Validation - Produce JSON schema for HSDS and HSDS, and publish API definition, and working HSDS/a API for validating.
  • Finalize - Take any feedback from Slack, Github, Google Group, and Spreadsheet and finalize the release of HSDA v1.1

v1.2

  • /complete - add an /everything to each core resource, allowing access to all sub resouces.
  • query - Shifting query parameter to be array, allowing for multiple fields to be queried.
  • content negotiation - Allow for JSON, XML, and responses.
  • sorting - Adding sorting.
  • pagination - Adding pagination.

v1.3

  • Error Codes - Establish a set of object definitions for returning errors as part of responses.
  • Status Code - Establish a set of status codes across all paths, and associate as reponses.

Use the Github issues for any questions and support.

The focus is primarily on the Human Services Data API (HSDA), but this work has been broken up into separate projects, to allow for separate of concerns, and versioning. You can find each project labeled:

These are separate projects to allow for them to be moved forward separately. They are also meant to act as separate microservices, that can be deployed, scaled, and managed indepedent of each other while still working in concert.