Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request for API name change: "schema" should be "metadata" #11

Closed
stuarteberg opened this issue Mar 24, 2014 · 0 comments
Closed

Request for API name change: "schema" should be "metadata" #11

stuarteberg opened this issue Mar 24, 2014 · 0 comments

Comments

@stuarteberg
Copy link
Member

In the DVID REST API, the following call returns a json file describing the axes, resolution, pixel type, etc.

/api/node/<UUID>/<data name>/schema

The word "schema" here is misleading, because that word is traditionally used to describe the structure of e.g. a json or xml tree. This data is not a schema in that sense -- I think the better term is "metadata".

Also: at some point, we will start publishing the json schemas for the messages produced by certain DVID API calls. To avoid confusion, we should not overload the term "schema" for API calls that return anything other than a true json schema.

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

No branches or pull requests

1 participant