Skip to content
This repository has been archived by the owner on Jan 2, 2019. It is now read-only.

Align JSON response from API endpoints to a standard #13

Open
ahirner opened this issue Feb 29, 2016 · 1 comment
Open

Align JSON response from API endpoints to a standard #13

ahirner opened this issue Feb 29, 2016 · 1 comment

Comments

@ahirner
Copy link
Owner

ahirner commented Feb 29, 2016

My bets go out to: http://jsonapi.org (for the fundamental layer)
And/or: http://json-ld.org (on top of it and later to blend well with semantic web ideas)

It's not necessary to strictly adhere to them since we have to optimize for a very specific case (lots of list-like representations with a finite typology), but if those standards don't interfere it's best to follow them from the onset.

@ahirner ahirner added this to the Architecture Freeze milestone Mar 16, 2016
@ahirner
Copy link
Owner Author

ahirner commented Mar 16, 2016

From conversation with Shane:
It is not always guaranteed that the 'value', i.e. column header is a unique string even if tables are parsed 100% accurate (could be empty) and fabricating artificial headers like 'column_1' is not an elegant. Thus, one minimum improvement is to include a unique key into the array of meta-data in the returned data.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant