TIDES icon indicating copy to clipboard operation
TIDES copied to clipboard

🚀💻 – Reconsider how to repesent the list of schemas within TIDES suite

Open e-lo opened this issue 2 years ago • 2 comments

User Story

As a developer and user, I want to leverage standardized functionality for listing packages of files and the interplay between them so that it is:

  • maintainable and easily usable with existing toolsets (read: not maintained by us), and
  • understandable to others leveraging similar standards without having to do a lot of explaining.

Context

  • tides.spec.json currently lists all the schemas as frictionless resources, but it is not, in and of itself, conformant to a schema within the realm of frictionless.
  • tides.spec.json is currently used in auto-generating the documentation, but this could probably be updated to just pull in all the schema files.
  • The tabular-data-package definition requires an additional file be shipped with each set of data (datapackage.json) which defines a set of resources –  which files exist and what schemas they use in addition to metadata.
  • For the purposes of defining how a datapackage.json can be structured outside the bounds of a tabular-data-package, Frictionless uses the concept of profiles, which are a definition of the json-schema for datapackage.json.

Solutions

Alternatives

Options so far:

  1. do nothing, keep tides.spec.json
  2. translate tides.spec.json to a profile (see example of how this was done for camera trap data)
  3. Remove tides.spec.json and autogenerate documentation from anything in the /spec folder
  4. ?? bueller ??

Additional Context

e-lo avatar Oct 07 '22 17:10 e-lo