-
Notifications
You must be signed in to change notification settings - Fork 500
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
10202 extend get version files api to include total file count #10215
10202 extend get version files api to include total file count #10215
Conversation
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
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.
It looks good to me!
I just added a couple of comments related to the code.
I think we should mention the new total count response field in the documentation. See: native-api.rst
(List Files in a Dataset). There are some examples of calling the endpoint using pagination params. It might be a good place to mention it.
Please also add a release note describing the change.
src/main/java/edu/harvard/iq/dataverse/api/AbstractApiBean.java
Outdated
Show resolved
Hide resolved
I just realized that Jenkins step is failing, but I can't see the job (network permissions). |
This comment has been minimized.
This comment has been minimized.
This was a Jenkins issue that was fixed |
This comment has been minimized.
This comment has been minimized.
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.
Looks good @stevenwinship, thank you for applying the changes.
I just added minor formatting tweaks to the docs.
📦 Pushed preview images as
🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
What this PR does / why we need it:
Extend getVersionFiles API endpoint to include the total file count, which is required for pagination
Which issue(s) this PR closes: #10202
Closes #10202
Special notes for your reviewer:
Suggestions on how to test this: call getVersionFiles. response should have total_count in addition to the status and data fields
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?:
Additional documentation: