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

As a user, I want to know the DOI associated with a product through the API metadata #89

Open
1 of 2 tasks
jordanpadams opened this issue May 26, 2021 · 5 comments
Open
1 of 2 tasks

Comments

@jordanpadams
Copy link
Member

jordanpadams commented May 26, 2021

Motivation

...so that I can easily search for and find a product and cite it.

Additional Details

Acceptance Criteria

Given a collection or bundle that has a DOI
When I perform a query of the search API for that specific product (e.g. products/{identifier}
Then I expect the metadata to include a meta field ops.doi.

Engineering Details

  • document an API example for how to track down a DOI for a particular product

    • search for parent collection and return DOI only
    • if not found, search for parent bundle and return DOI only
  • Update the new registry with DOI metadata (Develop script to sync DOIs to registry doi-service#249)

  • Update the legacy registry with DOI metadata
@jordanpadams jordanpadams added requirement the current issue is a requirement needs:triage labels May 26, 2021
@jordanpadams jordanpadams self-assigned this May 26, 2021
@jordanpadams jordanpadams changed the title As a user, I want to know the DOI associated with a product As a user, I want to know the DOI associated with a product through the API metadata Dec 21, 2021
@jordanpadams
Copy link
Member Author

@tdddblog as a follow-on to NASA-PDS/doi-service#249, we want to now add to our pds search api documentation, an example of how you could search and find a DOI for a particular bundle/collection/product. see ticket description above for more details

@tloubrieu-jpl
Copy link
Member

We need to add a cook book for APi users which will be in the Search API User guide section of the https://nasa-pds.github.io/pds-api/ .

This is initiated in PR #171

@jordanpadams
Copy link
Member Author

🕐 initial documentation included for querying for parent bundle/collection to get the associated DOI

@jordanpadams
Copy link
Member Author

documenting how to do this is done: https://nasa-pds.github.io/pds-api/guides/search/cookbook.html#search-for-dois

@jordanpadams
Copy link
Member Author

tabling this ticket to next build. remaining TBDs

  • test more rigorously against a test registry
  • setup the script as a cron job

See Usage info here: https://github.com/NASA-PDS/supplementer#add-doi-metadata-from-database

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

No branches or pull requests

4 participants