IQSS / IQSS/dataverse

Some fields for dataset types can't be edited (displayName, description)

Open
#12,192 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In #11753 I added displayName and description fields for dataset types but they can't be edited via API (and there's no UI).

I didn't implement editing because we have these two commands already...

... but we might want to merge these into a single UpdateDatasetTypeCommand that allows you to edit all the possible fields:

  • name
  • displayName
  • description
  • linkedMetadataBlocks
  • availableLicenses

I imagine we'd use a PUT to overwrite existing values.

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 reading UpdateDatasetTypeLinksToMetadataBlocksCommand.java and UpdateDatasetTypeAvailableLicensesCommand.java in src/main/java/edu/harvard/iq/dataverse/engine/command/impl/. Trace how the existing commands are exposed through the API and decide how a PUT should overwrite name, displayName, description, linkedMetadataBlocks, and availableLicenses. Done means all listed dataset type fields can be edited through the API.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.