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

Create GetCollection use case #131

Closed
GPortas opened this issue Mar 5, 2024 · 3 comments · Fixed by #134
Closed

Create GetCollection use case #131

GPortas opened this issue Mar 5, 2024 · 3 comments · Fixed by #134
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. SPA: Collection Page

Comments

@GPortas
Copy link
Contributor

GPortas commented Mar 5, 2024

Overview of the Feature Request

We need to implement a use case in the package for retrieving a collection. This use case will be utilized on the Collection page of the SPA.

Currently, for the SPA, we require the following properties to be added to the new collection model: name, affiliation, description, and owner information. Additionally, we need to map any other properties present in the API response payload that might be useful for any package consumer.

We can rely on the GetDataset use case as an example for the development of the new use case.

The API endpoint associated to the new use case is the /api/dataverses/{id} endpoint: https://github.com/IQSS/dataverse/blob/develop/src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java#L613

In case we find missing properties in the payload, we need to create an API extension issue.

What kind of user is the feature intended for?

SPA user

What inspired the request?

  • Frontend meeting for devs and SPA needs
@GPortas GPortas added Size: 33 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 SPA: Collection Page labels Mar 5, 2024
@GPortas GPortas transferred this issue from IQSS/dataverse-frontend Mar 5, 2024
@M27Mangan M27Mangan moved this from This Sprint 🏃‍♀️ 🏃 to In Progress 💻 in IQSS Dataverse Project Mar 6, 2024
@M27Mangan M27Mangan self-assigned this Mar 6, 2024
@M27Mangan
Copy link

M27Mangan commented Mar 6, 2024

@GPortas In your opinion, where should the useCase for Collections be in the file structure? I see src/datasets as a likely location but also unsure whether we are separating them out into something like src/collections ? @MellyGray also looking for your advice as always :)

Edit: Looks like in the useCases file we have specified the NewDatasetDTO in /src/datasets/domain/dtos/NewDatasetDTO.ts so I will go off of that unless otherwise specified.

@MellyGray
Copy link
Contributor

@M27Mangan, I would recommend placing it under /src/collections because a collection is not a dataset but rather an entity in itself. So, it makes sense to separate it into its distinct directory

@M27Mangan
Copy link

PR #134 opened for review

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. SPA: Collection Page
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants