Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Liability statement (liablityStatement) wrong key value written to mdJSON #497

Closed
6 tasks done
hmaier-fws opened this issue Nov 28, 2022 · 2 comments · Fixed by #557
Closed
6 tasks done

Liability statement (liablityStatement) wrong key value written to mdJSON #497

hmaier-fws opened this issue Nov 28, 2022 · 2 comments · Fixed by #557
Assignees
Labels
bug Unexpected problem or unintended behavior !!Priority!! Needs to happen ASAP!

Comments

@hmaier-fws
Copy link
Contributor

hmaier-fws commented Nov 28, 2022

The mdEditor incorrectly writes the "liabilityStatement" to mdJSON as "liablityStatement" (missing "i"). The translator correctly imports from CSDGM and writes to JSON as liabilityStatement.

Records imported from CSDGM may contain a correctly named key, which will not be displayed in the editor. Subsequent editing of the record could result in the presence of two statements, one with the correcly spelled key and another with the incorrectly spelled key.

Tasks:

  • Rename key in mdEditor to liabilityStatement
  • Determine how to fix existing data. (perform on import and export)
  • Case 1: no liability statement present; no action needed.
  • Case 2: single liability statement using correct spelling; no action needed.
  • Case 3: single liability statement using incorrect spelling; rename key or copy and delete.
  • Case 4: two liability statements present using both correct and incorrect keys. The value of the misspelled key (entered via the editor) shall replace the value of the correctly spelled key (imported from CSDGM). The misspelled key shall then be deleted from the JSON.

See:

I see the issue, it looks like there a misspelling, liablityStatement vs liabilityStatement (missing i)

this is coming from mdEditor

since this is in the Production version I'll do a little digging on how we can handle upgrading existing mdJson to the correct spelling transparently in the editor, and I suppose we should handle both spellings in the translator

Originally posted by @timothypage in adiwg/mdTranslator#236 (comment)

@hmaier-fws hmaier-fws added bug Unexpected problem or unintended behavior discussion Issue for discussion by stakeholder group !!Priority!! Needs to happen ASAP! labels Nov 28, 2022
@hmaier-fws hmaier-fws removed the discussion Issue for discussion by stakeholder group label Dec 20, 2022
@hmaier-fws hmaier-fws added this to Desired in Initial Release via automation Dec 20, 2022
@hmaier-fws hmaier-fws moved this from Desired to Mandatory in Initial Release Dec 20, 2022
@hmaier-fws
Copy link
Contributor Author

hmaier-fws commented Jul 6, 2023

@jwaspin before PR #557 can be merged in, the logic to handle use cases 3 and 4 needs to be added otherwise users may experience data loss.

@jwaspin
Copy link
Contributor

jwaspin commented Jul 10, 2023

adiwg/mdTranslator#236 is related

Initial Release automation moved this from Mandatory to Done Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Unexpected problem or unintended behavior !!Priority!! Needs to happen ASAP!
Projects
Development

Successfully merging a pull request may close this issue.

2 participants