IQSS / IQSS/dataverse

Feature Request: Add allowed datasetTypes to Collection JSON Schema

Open
#11,574 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

When retrieving the JSON Schema for datasets in a given collection using /api/dataverses/<id>/datasetSchema, it would be really helpful to include the property datasetType with an enumaration of the allowed values for the collection.

I know that currently there is no limitations to the types that may be added to a collection, but this might very well happen in the future. So for now, this would simply be a list of all instance-wide dataset types, ready to be refined if need arises.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the implementation of the /api/dataverses/<id>/datasetSchema endpoint and tracing how its JSON Schema is assembled. Identify where instance-wide dataset types are defined or retrieved; done means the response includes a datasetType property with those values as an enum.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.