IQSS / IQSS/dataverse

Inconsistency of metadata validation in API's

Open
#7,963 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

There is inconsistency in metadata validation in Dataverse APIs.
For example, one can create a dataset without a required metadata field such as "Subject". Using API one can also add files for that dataset and update metadata of a dataset without a problem. But updating file metadata of that dataset will fail on schema validation. Also delete file SWORD api will fail on validation.

It seems more logical either to require to have required fields in dataset creation api and update dataset metadata API or remove validation from update file metadata and delete file SWORD api.

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 dataset creation, dataset metadata update, file metadata update, and file-delete SWORD API entry points, then compare where schema validation is applied. Determine the intended consistent validation policy with maintainers and add coverage for the affected API operations; done means all relevant endpoints handle required metadata consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.