TIDES
TIDES copied to clipboard
🚀💻 – Reconsider how to repesent the list of schemas within TIDES suite
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 frictionlessresources
, 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 ofresources
– 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 atabular-data-package
, Frictionless uses the concept ofprofiles
, which are a definition of the json-schema fordatapackage.json
.
Solutions
Alternatives
Options so far:
- do nothing, keep
tides.spec.json
- translate
tides.spec.json
to aprofile
(see example of how this was done for camera trap data) - Remove
tides.spec.json
and autogenerate documentation from anything in the /spec folder - ?? bueller ??