Skip to content
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

Merged

Conversation

stevenwinship
Copy link
Contributor

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:

@stevenwinship stevenwinship added User Role: API User Makes use of APIs pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. labels Jan 8, 2024
@stevenwinship stevenwinship marked this pull request as draft January 8, 2024 21:33

This comment has been minimized.

1 similar comment

This comment has been minimized.

Copy link
Contributor

@GPortas GPortas left a 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.

@GPortas
Copy link
Contributor

GPortas commented Jan 9, 2024

I just realized that Jenkins step is failing, but I can't see the job (network permissions).

@GPortas GPortas self-assigned this Jan 9, 2024
@GPortas GPortas removed their assignment Jan 9, 2024

This comment has been minimized.

@stevenwinship stevenwinship marked this pull request as ready for review January 9, 2024 16:17
@stevenwinship stevenwinship removed their assignment Jan 9, 2024
@stevenwinship
Copy link
Contributor Author

I just realized that Jenkins step is failing, but I can't see the job (network permissions).

This was a Jenkins issue that was fixed

This comment has been minimized.

Copy link
Contributor

@GPortas GPortas left a 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.

doc/sphinx-guides/source/api/native-api.rst Outdated Show resolved Hide resolved
@GPortas GPortas added the SPA These changes are required for the Dataverse SPA label Jan 9, 2024
@coveralls
Copy link

Coverage Status

coverage: 20.163% (-0.002%) from 20.165%
when pulling dfb1795 on 10202-extend-getVersionFiles-api-to-include-total-file-count
into 17bfeb9 on develop.

Copy link

github-actions bot commented Jan 9, 2024

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10202-extend-getVersionFiles-api-to-include-total-file-count
ghcr.io/gdcc/configbaker:10202-extend-getVersionFiles-api-to-include-total-file-count

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@stevenwinship stevenwinship removed the request for review from landreev January 9, 2024 22:17
@sekmiller sekmiller self-assigned this Jan 10, 2024
@sekmiller sekmiller merged commit b52fede into develop Jan 10, 2024
12 checks passed
@sekmiller sekmiller deleted the 10202-extend-getVersionFiles-api-to-include-total-file-count branch January 10, 2024 18:39
@pdurbin pdurbin added this to the 6.2 milestone Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA User Role: API User Makes use of APIs
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Extend getVersionFiles API endpoint to include the total file count, which is required for pagination
5 participants