6524 dataset size api #6609
6524 dataset size api #6609
Conversation
at dataset/version level
There was a problem hiding this comment.
Overall, this looks fine so I'm moving it to QA but heads up to @sekmiller that I left some comments and suggestions.
|
|
||
| export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | ||
| export SERVER_URL=https://demo.dataverse.org | ||
| export ID=xxxxxx |
There was a problem hiding this comment.
| export ID=xxxxxx | |
| export ID=42 |
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/datasets/xxxxxx/storagesize |
There was a problem hiding this comment.
| curl -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/datasets/xxxxxx/storagesize | |
| curl -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/datasets/42/storagesize |
|
|
||
| export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | ||
| export SERVER_URL=https://demo.dataverse.org | ||
| export ID=xxxxxx |
There was a problem hiding this comment.
| export ID=xxxxxx | |
| export ID=42 |
| export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | ||
| export SERVER_URL=https://demo.dataverse.org | ||
| export ID=xxxxxx | ||
| export VERSIONID=x.x |
There was a problem hiding this comment.
| export VERSIONID=x.x | |
| export VERSIONID=1.0 |
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/datasets/xxxxxx/versions/x.x/downloadsize |
There was a problem hiding this comment.
| curl -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/datasets/xxxxxx/versions/x.x/downloadsize | |
| curl -H X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx https://demo.dataverse.org/api/datasets/42/versions/1.0/downloadsize |
| long total = 0L; | ||
|
|
||
| if (dataset.isHarvested()) { | ||
| return 0L; | ||
| } | ||
|
|
||
| List<DataFile> filesToTalley = new ArrayList(); |
There was a problem hiding this comment.
Sorry to nitpick but it's "tally" without an "e".
| /** | ||
| * Returns the total byte size of the files in this dataset | ||
| * | ||
| * @param dataset | ||
| * @param countCachedExtras boolean indicating if the cached disposable extras should also be counted | ||
| * @param mode String indicating whether we are getting the result for storage (entire dataset) or download version based |
There was a problem hiding this comment.
It would be nice to document the accepted values for "mode".
|
|
||
| private final Dataset dataset; | ||
| private final Boolean countCachedFiles; | ||
| private final String mode; |
There was a problem hiding this comment.
Instead of a String for "mode" and enum would be nice. More type safe that way. And auto documenting.
|
@pdurbin if there are suggested changes let's not start QA yet. @sekmiller feel free to respond to the feedback above and let me know if you want me to edit any docs. |
|
@djbrooke that's fine but I want to re-emphasize that I don't see any changes as required. Again, they're just suggestions. 😄 |
|
@pdurbin thanks, yeah, I 100% agree and understand, but I don't want @kcondon to start QA and have things shift under him if @sekmiller plans to make the changes. |
|
I addressed the coding suggestions that @pdurbin made, but I'm going to leave the doc as is for now since it is in line with what is already there for other api endpoints. |
What this PR does / why we need it:
This PR add API endpoints for getting the storage size of a dataset and getting the sum of size of the files available for download in a particular version of a dataset.
Which issue(s) this PR closes:
Closes #6524
Special notes for your reviewer:
None
Suggestions on how to test this:
Note that the storage size api requires that the token passed has view unpublished. Likewise for the download size, if the version is :draft there must be a token passed with view unpublished permission. No token is required for a published version.
Does this PR introduce a user interface change?:
No
Is there a release notes update needed for this change?:
No. (could be included in "additional features/fixes."
Additional documentation:
added doc to native-apt.rst