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

Feature Request: Offer the complete report as JSON #82

Open
1Maxnet1 opened this issue Jul 27, 2023 · 2 comments
Open

Feature Request: Offer the complete report as JSON #82

1Maxnet1 opened this issue Jul 27, 2023 · 2 comments

Comments

@1Maxnet1
Copy link

Hello,
for our use case we wanted to have the complete report of as JSON-Output. However currently the JSON-Output only provides a summary, but not the complete report, as stated in the help text: "JSON validation report (summary only for now) output file"

Are there any plans to add the complete report as JSON-Output instead of only a summary?

I would also be interested to contribute to this feature.

@laurentg
Copy link
Member

No plan to add this feature, but if you want to participate, any contribution welcome!

@laurentg
Copy link
Member

Some more implementation details. The JSON output is generated by the JsonReportFormatter class. See the convert method, where the method should convert each ReportIssue from the ReviewReport.

Please be aware that the JSON export do have "append" mode, so the JSON data report binding class is split in JsonValidationRun, each containing what should be exported for one validation run (currently only contains categories and a count summary).

In summary, adding full reporting capabilities to the JSON output should be rather straightforward, one just have to complete the JSON model, and loop on each issues to convert them to the JSON java model.

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

2 participants