Skip to content

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Sep 22, 2025

What this PR does / why we need it:

I added use cases for the various API endpoints at https://guides.dataverse.org/en/6.7.1/api/native-api.html#dataset-types except for getDatasetAvailableDatasetTypes, which was already implemented in this PR:

Here's the complete list now:

  • getDatasetAvailableDatasetTypes
  • getDatasetAvailableDatasetType
  • addDatasetType
  • linkDatasetTypeWithMetadataBlocks
  • setAvailableLicensesForDatasetType
  • deleteDatasetType

Which issue(s) this PR closes:

Special notes for your reviewer:

I'll add some comments on specific lines under "files changes" so we can have a thread per note.

Suggestions on how to test this:

In addition to the included tests, I used this script: crud.ts.txt

You can call it like this:

npx tsx crud.ts --base-url $SERVER_URL/api/v1 -a $API_TOKEN 

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

Yes, it should say the following use cases are supported:

  • getDatasetAvailableDatasetTypes
  • getDatasetAvailableDatasetType
  • addDatasetType
  • linkDatasetTypeWithMetadataBlocks
  • setAvailableLicensesForDatasetType
  • deleteDatasetType

Additional documentation:

Included in use cases doc.

@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Sep 22, 2025
@pdurbin pdurbin added the GREI Re-arch GREI re-architecture-related label Sep 23, 2025
@g-saracca g-saracca moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Sep 23, 2025
@g-saracca g-saracca self-assigned this Sep 23, 2025
Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

All good! really solid! Approving

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Sep 23, 2025
@g-saracca g-saracca removed their assignment Sep 23, 2025
@ofahimIQSS
Copy link
Contributor

tests passing - merging PR

@ofahimIQSS ofahimIQSS merged commit 9d02003 into develop Sep 24, 2025
5 checks passed
@github-project-automation github-project-automation bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project Sep 24, 2025
@ofahimIQSS ofahimIQSS deleted the 370-dataset-types-crud branch September 24, 2025 02:35
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Sep 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GREI Re-arch GREI re-architecture-related

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Add, Edit, and Delete Dataset Type Use Cases

3 participants