Additions to the Locks API #8445
Merged
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
sekmiller
reviewed
Feb 23, 2022
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl -H "X-Dataverse-key: xxx" "http://localhost:8080/api/datasets/locks?type=Ingest&userIdentifier=davis4ever" |
sekmiller
approved these changes
Feb 23, 2022
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:
This is the code part of IQSS/dataverse.harvard.edu#135, the local issue opened for dealing with the backlog of dataset locks in production.
This PR extends the existing locks API by adding an end point for listing all the locks that are present (the old API is limited to checking for locks on specific datasets). Going forward this API can be used to monitor locks without having to run database queries.
Listing can be filtered by lock type and user with the optional query parameters.
Which issue(s) this PR closes:
Closes IQSS/dataverse.harvard.edu#135
Special notes for your reviewer:
The new API is superuser-only. I briefly considered placing it under /api/admin, but decided to keep it under /api/datasets with the existing locks APIs. In practice we will want this new API to be used by admin users who may not have access to localhost.
The rest of it is very straightforward.
Suggestions on how to test this:
Should be self-explanatory based on the documentation section in the API guide.
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: