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

JSON: inconsistent naming #228

Open
maria-messerschmidt opened this issue Jan 21, 2025 · 0 comments
Open

JSON: inconsistent naming #228

maria-messerschmidt opened this issue Jan 21, 2025 · 0 comments

Comments

@maria-messerschmidt
Copy link

Certain keys in the JSON output are used several times for different value categories:

The name of the file being validated is referred to as:

  • "name" inside the non-profile report
  • "id" at the top level of the profile report
  • "name" in the validationResult object in the profile report

Furthermore, "id" is also used as a key to refer to the message code, e.g. "PKG-2",
and "name" is also used to refer to the profile value "DNA ODF Spreadsheets Preservation Specification“.

These keys should be used consistently to refer to one thing, e.g.

"file_name" or "id" for name of the file
"message_code" for the message code
"profile" for the profile value

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant