search

openreferral / api-specification

This is the working repository for Open Referral's Human Services Data API protocols.
https://openreferral.readthedocs.io/en/latest/hsda/
Other
29 stars 13 forks source link

Couple of fixes and refactoring due to unparseable OpenAPI definition #14

Closed xrysanthos closed 7 years ago

xrysanthos commented 7 years ago

Hi Kin,

wanted to follow the discussion around the Open Referral API triggered in your article https://apievangelist.com/2017/04/14/from-crud-to-an-api-design-conversation-with-human-services/.

Tried to load up the OpenAPI definition into swagger.ed but noticed that it couldn't be parsed due to an invalid structure (array instead of object) within the YAML file.

Also, the live project site had a number of broken links due to a hard-coded base path issue. Therefore I decided to jump in and commit a number of fixes that solved these issues. Have a look at my commit messages - pretty much describing the issues and actions taken.

I've also excluded the compiled '_site' folder from the repo (no need to have that in there) and added a basic Gemfile so that anyone can run it locally with Jekyll.

Let me know what you think.

kinlane commented 7 years ago

Chris you are the best. Thank you for this. I neglected some steps in QA to get out the door for our governance call. I appreciate you stepping in and helping. It means a lot!

xrysanthos commented 7 years ago

It's the least I can do Kin. Thanks!