search

webrecorder / specs

Specifications developed and maintained by the Webrecorder community.
https://specs.webrecorder.net
122 stars 13 forks source link

datapackage.json "profile" key #118

Closed steko closed 2 years ago

steko commented 2 years ago

Hello and thanks for creating this spec!

I think there is a small inconsistency in the section about datapackage.json.

In the first paragraph it reads:

It MUST contain the following keys:

  • profile: Set to data-package

(this is what py-wacz does: https://github.com/webrecorder/py-wacz/blob/fbd3657281c30aaac0cc14cedb6c7f0692d07a24/wacz/waczindexer.py#L334 )

But a few paragraphs below it gives a different indication:

The datapackage.json MUST be a valid JSON object and include properties that allow rendering applications to present the user with contextual information about the web archive:

  • profile: the string "wacz/1.2.0"
edsu commented 2 years ago

Thanks for noticing this inconsistency. @ikreymer recently decided he wants the v1.2.0 spec to accurately describe existing WACZ that is out there. There is a lot more of it because of the recent work on SUCHO. Using the profile field differently was going to be part of an incremental improvement that we will save for a potential future version of WACZ. So we will be going with the former data-package for now.