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

Implemetation of Error objects #146

Open
ymark opened this issue Dec 9, 2021 · 0 comments
Open

Implemetation of Error objects #146

ymark opened this issue Dec 9, 2021 · 0 comments
Assignees

Comments

@ymark
Copy link
Collaborator

ymark commented Dec 9, 2021

In order to enhance the information about error messages, we're about to handle them using Error objects.
Error objects will contain different aspects of information about the error that occurred. That object can be thereafter used as we like, e.g. for generating a small narrative intended for humans, constructing a JSON report intended for application, generating an HTML summary, etc.

The purpose of this issue is to draft the original design of such Error objects. The actual messaging and exploitation (e.g. narratives, json objects, etc.) will be discussed in a separate issue.

The indicative contents of the Error Message could be:

  • identifier: e.g. a UUID
  • timestamp: when the error occurred
  • type: selected from a controlled vocabulary (e.g. missing generator, missing XPATH, missing resources, etc.)
  • severity: selected from a controlled vocabulary (e.g. warning, error, fatal)
  • mapping: the number of the mapping were the error was thrown (this will allow spotting the cause easily)
  • link: the number of the link (inside the mapping) were the error was thrown (this will allow spotting the cause easily)
  • description: a short narrative describing the error
  • suggested_resolution: a short narrative describing how to deal with the problem
@ymark ymark assigned ymark and unassigned ymark Dec 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant