!feat: enable user defined 'id' for reports so that the get URL can be stable. Breaking change as 'id' will be required to function.

[mswertz]

What are the main changes you did

• enable user defined ID for reports because now URLs were not stable (report index could change depending on load order)

How to test

• view the report and see that the URL now uses the id if exists

Question to reviewers:

• can we make this a breaking change by stopping use of the index as alternative id?
• do you want to remove 'name' or should we use it as human readable 'label' in report list?
• we could change URL to be of pattern /report/id or in case of multiple /report/id,id2 to make it more look like REST

enhancements skipped in view of time

• uniqueness check
• regexp to make id be a-zA-Z0-9 (certainly shouldn't contain ',')

[harmbrugge]

Code looks good

[davidruvolo51]

This is a really good feature that will help us with the dashboards and other custom applications. I have a few comments about the documentation as well as some potential limitations.

Questions / pitfalls

Should there be strict rules regarding the ID of the report? For example, I created a report in the preview called "country summary". Calling the report over the api at https://preview-emx2-pr-4520.dev.molgenis.org/test/api/report/country%20summary/ returns a "file not found" error. I would expect it to work as noted in the documentation. If I rename the report to "country", then it works fine.

What is the correct API URL for the reports?

Are there multiple options for requesting a report? This is a follow up to the previous item. There are multiple endpoints for retrieving a report output. Is this expected?

http://<host>/<schema>/api/reports/<report>
http://<host>/<schema>/api/reports/json?id=<report>

[sonarqubecloud]

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
80.8% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[davidruvolo51]

Looks good! I think we can merge.