Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add provenance info to HAPI info response #186

Open
jvandegriff opened this issue Nov 6, 2023 · 5 comments
Open

add provenance info to HAPI info response #186

jvandegriff opened this issue Nov 6, 2023 · 5 comments

Comments

@jvandegriff
Copy link
Collaborator

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:

  • DOI (can be list)
  • version (also a list?)
  • modification date
  • dependencies (can of worms)
@dlindhol
Copy link

dlindhol commented Nov 7, 2023

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

@rweigel
Copy link
Contributor

rweigel commented Nov 7, 2023

@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.

@rweigel rweigel added this to the Version 3.3 milestone Mar 18, 2024
@jvandegriff
Copy link
Collaborator Author

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
Copy link
Contributor

jbfaden commented Jul 31, 2024

See also #217

@rweigel
Copy link
Contributor

rweigel commented Nov 20, 2024

Conclusion #224 (comment)

For HAPI 4.0, if demand, consider adding provenanceSchema and allowing provenance to be an object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants