search

OpenDataServices / org-ids

Front end application for http://org-id.guide
http://org-id.guide
Other
17 stars 9 forks source link

Create JSON Schema for our format #22

Closed timgdavies closed 7 years ago

timgdavies commented 7 years ago

We should create a JSON Schema to describe the format we are using for codelist entries.

This would:

(a) Ensure we are have clearly defined the meaning of each field; (b) Support third-parties to create valid information; (c) Support testing of pull requests; (d) Potentially help power future editing interfaces;

Questions to address:

timgdavies commented 7 years ago

I've started a branch to do this at https://github.com/OpenDataServices/org-ids/tree/schema/schema which is currently populated with a draft generated with http://jsonschema.net/#/ from an example codelist entry.

This is throwing up a couple of issues:

(1) It doesn't seem to make sense when asking people to submit data for them to follow the pattern of including country names as well as ISO codes for jurisdiction

(2) Similar for 'structure' where we have the information on entity heirarchy.

@kindly Does the current app use this information? Or does it defer to other sources to get country names etc?

timgdavies commented 7 years ago

Schemas are now created at https://github.com/org-id/register/tree/master/schema