8290 harvest client api #9174
Merged
8290 harvest client api #9174
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pdurbin
reviewed
Nov 22, 2022
|
|
||
| - archiveDescription: What the name suggests. If not supplied, will default to "This Dataset is harvested from our partners. Clicking the link will take you directly to the archival source of the data." | ||
| - set: The OAI set on the remote server. If not supplied, will default to none, i.e., "harvest everything". | ||
| - schedule: Harvesting schedule. Defaults to "none". |
There was a problem hiding this comment.
Can we have an example of a schedule? What does it look like?
On a related note, I see this comment in the code:
// TODO: Make schedule configurable via this API too.
Perhaps this means that schedule cannot be configured via API? If so, we should say so. Or if schedule can be set on create but not on modify we could document that under "Modify a Harvesting Client".
src/main/java/edu/harvard/iq/dataverse/api/HarvestingClients.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
|
(I have added some simple restassured tests, as discussed) |
pdurbin
approved these changes
Nov 29, 2022
|
Issues found:
|
|
Kevin is satisfied with everthing, but uncovered a missed use case. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Our API for creating harvesting clients was an afterthought, we never got it fully to work, and never advertised or documented it. However a user discovered it and reported that it wasn't working. We will need this API to create functional restassured tests for harvesting clients (there's a dedicated issue that's been prioritized recently).
This PR provides a working API for creating a new harvesting client (with an
-X POSTmethod) and documents it in the guide. The documentation part of the PR should thus close the issue #8267 as well.Which issue(s) this PR closes:
Closes #8290
Closes #8267
Special notes for your reviewer:
I'm not adding restassured tests for this API in this PR, because there's a dedicated issue for harvesting tests that's also been prioritized.
Suggestions on how to test this:
It should be possible to create a new client, with an
-X POSTmethod, as documented. The List, Edit and Delete, not specifically mentioned in the issue, should also be working as documented.Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: