Iqss/7952 extended traces api #7953
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
djbrooke
added this to Review 🦁
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
via automation
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from Review 🦁
to QA 🔎✅
Jun 24, 2021
scolapasta
approved these changes
Jun 24, 2021
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from QA 🔎✅
to Done 🚀
Jun 28, 2021
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: Extends the api/users/<id>/traces api to allow retrieval of specific types of traces independently.
Which issue(s) this PR closes:
Closes #7952
Special notes for your reviewer: The extension also allows requesting csv or json outputs. CSV is the default, mirroring the metrics API but the default could be switched back to json if preferred.
Adding ?w=1 will help make the changes clearer: https://github.com/IQSS/dataverse/pull/7953/files?w=1
Suggestions on how to test this:
Adding a -H 'Accept:application/json' or -H 'Accept:text/csv' header in your curl call will provide json or csv versions of the outout.
Add any of the types listed in the issue onto a traces api call, e.g. /api/users/<id>/traces/datasetCreator and verify that it produces, with the Accept:application/json header, for all but one type, the same result as in the corresponding section of the existing /traces response.
For the one exception .../guestbookEntries - verify that the total number of entries reported is consistent with what /traces reports (.../guestbookEntries adds per-entry info that isn't in the original /traces response.
Testing could also check that the text/csv header produces the same info, just formatted differently.
Does this PR introduce a user interface change? If mockups are available, please link/include them here: No
Is there a release notes update needed for this change?: No
Additional documentation: Can document the new options if this goes forward