Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Descriptor definition; clarify JSON/YAML #50

Merged
merged 5 commits into from
Apr 10, 2024
Merged

Conversation

roll
Copy link
Member

@roll roll commented Apr 3, 2024


It's another take on frictionlessdata/datapackage#40. This pull request:

  • removes duplication using the common definitions section
  • keeps strictness regarding JSON requirements as well as datapackage.json naming

Although technically, it doesn't matter how datapackage.json file is named (anyway referenced by URI) it might be nice to keep naming strictness as it's already in v1 and it provides some benefits e.g. regarding usage analysis (for example, searching on github for datapackage.json etc)

@khusmann
Copy link
Contributor

khusmann commented Apr 9, 2024

When available as a file a descriptor MUST be named datapackage.json and it MUST be placed in the top-level directory (relative to any other resources provided as part of the data package).

Nice. Another place where this strictness is appreciated is when datapackages are zipped for distribution. Implementations can be pointed to a datapackage zip and selectively extract resources from it, without the user needing to unzip into a folder. I think this is helpful for adoption by novice users... it allows us to to a drop-in replacement for an *.xlsx file (which is also just a zip of tabular data).

I describe this use case in more detail here: frictionlessdata/frictionless-r#193

Copy link

cloudflare-workers-and-pages bot commented Apr 10, 2024

Deploying datapackage with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7fb1809
Status:⚡️  Build in progress...

View logs

@roll
Copy link
Member Author

roll commented Apr 10, 2024

ACCEPTED by WG (6/9)

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