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

115 - Create use case to get a file #119

Merged
merged 11 commits into from
Feb 5, 2024

Conversation

MellyGray
Copy link
Contributor

@MellyGray MellyGray commented Jan 25, 2024

What this PR does / why we need it:

This PR adds a new use case getFile to the module to get a file given its id or persistentId and an optional datasetVersion.

Which issue(s) this PR closes:

Related Dataverse PRs:

  • Depends on #

Special notes for your reviewer:

The API needs to be extended to accept the datasetVersion parameter, so for the moment this use case will throw a Not Implemented Yet error when the user specifies a datasetVersion different than draft or latest.

Suggestions on how to test this:

  1. Visual inspection of the code
  2. Check unit and integration tests execution in GitHub actions

Is there a release notes update needed for this change?

getFile use cases added to the module to get a file given its id or persistentId and an optional datasetVersion

Additional documentation:

@MellyGray MellyGray marked this pull request as draft January 25, 2024 14:16
@MellyGray MellyGray marked this pull request as ready for review January 26, 2024 13:15
@MellyGray MellyGray added the Size: 3 A percentage of a sprint. 2.1 hours. label Jan 26, 2024
@ekraffmiller ekraffmiller self-assigned this Jan 26, 2024
Copy link
Contributor

@ekraffmiller ekraffmiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good! I just have questions about how we will handle versioning.

test/unit/files/GetFileDraft.ts Outdated Show resolved Hide resolved
@ekraffmiller ekraffmiller added 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 labels Jan 29, 2024
@MellyGray MellyGray assigned ekraffmiller and unassigned MellyGray Jan 29, 2024
@MellyGray
Copy link
Contributor Author

@ekraffmiller, I think I might need to assign this to myself again after reading this explanation. It seems that files do not have versions. Therefore, fileVersionId should be renamed to dataverseVersionId in the GetFile use case

@MellyGray MellyGray assigned MellyGray and unassigned ekraffmiller Jan 30, 2024
@MellyGray MellyGray assigned ekraffmiller and unassigned MellyGray Jan 30, 2024
ekraffmiller
ekraffmiller previously approved these changes Jan 30, 2024
Copy link
Contributor

@ekraffmiller ekraffmiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The addition of datasetVersion parameter looks good, approved! Thanks for clarifying that.

@ekraffmiller ekraffmiller removed their assignment Jan 30, 2024
@GPortas GPortas self-assigned this Jan 31, 2024
@GPortas
Copy link
Contributor

GPortas commented Feb 1, 2024

@MellyGray Can you please solve merge conflicts?

@MellyGray MellyGray removed their assignment Feb 2, 2024
@GPortas GPortas mentioned this pull request Feb 5, 2024
2 tasks
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.

LGTM

@GPortas GPortas merged commit 7999562 into develop Feb 5, 2024
2 checks passed
@GPortas GPortas deleted the feature/115-create-use-case-to-get-a-file branch February 5, 2024 10:07
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: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Create use case to get a file
3 participants