Skip to content

Add use case for getting list of collections a user may create datasets in#418

Open
vera wants to merge 5 commits into
IQSS:developfrom
vera:feat/get-collections-for-creating
Open

Add use case for getting list of collections a user may create datasets in#418
vera wants to merge 5 commits into
IQSS:developfrom
vera:feat/get-collections-for-creating

Conversation

@vera
Copy link
Copy Markdown
Contributor

@vera vera commented Jan 27, 2026

What this PR does / why we need it:

This PR adds code for getting the list of collections a user may create datasets in.

Which issue(s) this PR closes:

/

Related Dataverse PRs:

/

Special notes for your reviewer:

/

Suggestions on how to test this:

I've added tests and docs on how to use.

Is there a release notes or changelog update needed for this change?:

Yes

Additional documentation:

/

@pdurbin pdurbin moved this to Ready for Triage in IQSS Dataverse Project Mar 31, 2026
@scolapasta scolapasta moved this from Ready for Triage to Ready for Review ⏩ in IQSS Dataverse Project Mar 31, 2026
@cmbz cmbz added the FY26 Sprint 20 FY26 Sprint 20 (2026-03-26 - 2026-04-08) label Apr 8, 2026
@ekraffmiller ekraffmiller added GREI Re-arch GREI re-architecture-related Size: 3 A percentage of a sprint. 2.1 hours. labels Apr 8, 2026
@cmbz cmbz added the FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) label Apr 8, 2026
@cmbz cmbz added the FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) label Apr 22, 2026
@cmbz cmbz added the FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) label May 6, 2026
@cmbz cmbz added the FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) label May 21, 2026
@ekraffmiller ekraffmiller self-assigned this Jun 1, 2026
@ekraffmiller ekraffmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Jun 1, 2026
@ekraffmiller
Copy link
Copy Markdown
Contributor

ekraffmiller commented Jun 2, 2026

Hi @vera thanks for your PR! I was just reviewing the API that this use case is wrapping, and it has some issues with it - it doesn't have a paging option, and if the endpoint is called for a user such as an admin that returns a long list of collections, the performance is not good.
We have a more general API, /mydata/retrieve, that takes parameters for paging, dvObject type, roles, and also allows filtering of the results by collection name. It's the API used in the MyData page to filter the table contents. With the right parameters, it can return a list of collections that a user can create a dataset in. Could that be used for your purposes instead? We are thinking we might deprecate the collectionList endpoint in favor of mydata/retrieve.

UPDATE: after talking to the team, we think it's better to keep collectionList as a separate API, and add pagination and filtering to it. I created an issue for it here: IQSS/dataverse#12423

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 20 FY26 Sprint 20 (2026-03-26 - 2026-04-08) FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) GREI Re-arch GREI re-architecture-related Size: 3 A percentage of a sprint. 2.1 hours.

Projects

Status: In Review 🔎

Development

Successfully merging this pull request may close these issues.

5 participants