openreferral / specification

The Human Services Data Specification - a data exchange format developed by the Open Referral Initiative
https://openreferral.org
Other
117 stars 49 forks source link

Generating ERD diagrams from JSON table schema #147

Closed duncandewhurst closed 7 years ago

duncandewhurst commented 7 years ago

I have been looking into tools for generating an ERD diagram from the OpenReferral JSON table schema.

I came across jts_erd which consumes an extended JSON table schema, generated from a PostgreSQL database, but I haven't yet been able to get this working with the OpenReferral schema.

The next avenue to investigate is tool to convert JSON table schema into a relational database, from which an ERD could be generated, but I would prefer to work directly with the JSON table schema if possible.

Please share thoughts or suggestions for any tools or libraries which might be useful.

Thanks!

timgdavies commented 7 years ago

@spilio has any of your exploration of data package tooling thrown up possibilities here?

MaxWhitney commented 7 years ago

openref er diagram v1 1 Not directly responsive (not a solution to the JSON to ERD tool question), but I drafted an ER diagram based on the Open Referral API v1.1 yaml.

A png of the draft is attached.

On Mon, Jun 19, 2017 at 8:17 PM, Kin Lane notifications@github.com wrote:

I'm working on a JSON schema for the Human Services Data Specification (HSDS), as well as for the surface area of the Human Service Data API (HDSA) -- my JSON schema chops aren't that sharp, so I'm still polishing and will share when ready.

Secondarily as part of my portal demo API that I'm keeping in alignment with the HSDS/A I will be publishing a MySQL script. I'll put on the list for translation for PostgreSQL on the working list.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/openreferral/specification/issues/147#issuecomment-309608313, or mute the thread https://github.com/notifications/unsubscribe-auth/AAWDQrHE3_BTBvTL0flh8suG8s6GlSXFks5sFw-LgaJpZM4N-eGR .

kinlane commented 7 years ago

Apologies misread question, and crossed with other -- clearing.

timgdavies commented 7 years ago

Thanks @MaxWhitney

I don't think the attachments come through for GitHub comments via e-mail. Could you drag and drop it into an issue reply at https://github.com/openreferral/specification/issues/147 ?

Thanks!

MaxWhitney commented 7 years ago

I attached the .png to my earlier message and have issued a pull request to include the diagram in a new 'er_diagram' folder in location openreferral/specification/

timgdavies commented 7 years ago

Belated thanks @MaxWhitney : this is now all merged in.

Will look at ways to keep it updated in future.