CDLUC3 / CDLUC3/dmptool-doc

Add warnings for RDA common standard properties we do not support

Open
#263 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Summary

There are some elements of the RDA Common Standard that we do not currently support in the DMP Tool. We need to add these to the plan.warnings object when they are present.

Context

A caller may pass in anything that is allowed in the RDA common standard. We need to record and warn the caller that the information will be ignored/dropped.

Links to impacted areas

Here is the list of things we do not currently support: https://github.com/CDLUC3/dmptool-api#exceptions-to-the-rda-common-standard-format

Design Information

The Plan already has a warnings object, we just need to add a function that checks the incoming maDMP record for the presence of these unsupported properties, and add a warning message

Acceptance criteria

Add more specific details here about what to implement and how the end behavior should work

  • We log a warning
  • A message is added to the plan.warnings
Relevant Technical Decisions

We just need to add them to the plan.warnings object at this time. The RDA group is determining how these will be conveyed to the caller in the response. We will add a ticket to return them once that has been defined.

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 with the RDA Common Standard exceptions list linked in the issue and inspect the existing Plan warnings handling. Identify how incoming maDMP records are checked, then verify that unsupported properties produce a logged warning and an entry in plan.warnings.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.