-
Notifications
You must be signed in to change notification settings - Fork 0
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 search and Doi versions APIs to Swagger #22
Conversation
@@ -524,13 +524,73 @@ paths: | |||
- preview | |||
produces: | |||
- application/json | |||
parameters: | |||
- in: query | |||
name: q |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
q
really?
Assume this is correct since they had to define it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, that's what the name is: https://inveniordm.docs.cern.ch/reference/rest_api_drafts_records/#search-records
parameters: | ||
- in: path | ||
name: recordId | ||
type: integer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docs define it as a string although I think we've been using integers for IDs elsewhere too
5c32042
to
ae14cff
Compare
Description
These APIs are necessary to find Zenodo DOIs referencing GitHub repos.
The first endpoint searches. If there multiple versions of the DOI, the search API only returns one version. Which brings us to the second endpoint, that retrieves all versions of a DOI. That would let us assign them to the corresponding Dockstore versions.
Corresponding (draft) PR for the web service at dockstore/dockstore#5880. Regardless of whether we decide to implement that feature, this should be safe.
Review Instructions
Review will be covered in the Dockstore PR.
Issue
dockstore/dockstore#5745
Security and Privacy
If there are any concerns that require extra attention from the security team, highlight them here.
e.g. Does this change...
Please make sure that you've checked the following before submitting your pull request. Thanks!
mvn clean install
@RolesAllowed
annotation