hapi-server / data-specification

HAPI Data Access Specification
https://hapi-server.org
22 stars 7 forks source link

add provenance info to HAPI info response #186

Open jvandegriff opened 10 months ago

jvandegriff commented 10 months ago

HAPI needs the ability to report where the data came from. Ideally this would be a DOI, and those are universal enough that we could add a field for that in the info response.

This means we should maybe revisit the ability for the server to return just the data with no header. Because it’s the header for a specific data request that should contain the DOI, or maybe a list of DOIs. Currently, most people don't really request the info for a specific time range - they just get it once to se what the parameters are. And some datasets use one DOI per file, or group of files. This one-DOI-per-file is not what is currently recommended by IHDEA, but actually there is not a solid agreement on that yet.

Maybe having a provenance block, and offer a list of suggested keywords:

dlindhol commented 10 months ago

We should consider looking at PROV-O for inspiration (e.g. names of properties).

rweigel commented 10 months ago

@jvandegriff keep in mind that CSV and Binary are transport formats, not file formats.

We should research the previous discussion on headerless as default before re-hashing. This has come up over and over.

A change in default would break many things.

jvandegriff commented 1 month ago

This needs longer discussion - possible other endpoint, or when getting data, add an include=provenance

Note that info responses can already include a resourceURL and also a citation

jbfaden commented 1 month ago

See also #217