search

icatproject / icat.server

The ICAT server offering both SOAP and "RESTlike" interfaces to a metadata catalog.
Other
1 stars 5 forks source link

ICAT Restful API documentation is missing for icat.server 6.0 #310

Closed RKrahl closed 4 months ago

RKrahl commented 1 year ago

If you check the landing page for the current icat.server version 6.0 and click on the RESTful interface link, you get a 404. E.g. the Miredot generated docu is missing from the site. (The corresponding link for icat.server 5.0.1 works.)

I guess, the cause is related to the following error message that I get when trying to build icat.server 6.0:

[INFO] --- miredot-plugin:2.4.1-Java11:restdoc (miredot) @ icat.server ---
[WARNING] Miredot is unable to document the status codes of rest interfaces, unless a statusCodes-block is specified in pom.xml
[WARNING] Rest Framework not explicitly set, using JAX-RS by default.
[INFO] Building reflective model of API and reading annotations...
[ERROR] Your project doesn't contain any REST interfaces, so no output will be generated.
Maybe it is incorrectly configured.
ajkyffin commented 11 months ago

It looks like Miredot does not find any REST annotations because they have changed to the jakarta namespace and it is scanning for annotations from the javax namespace.

moonraker595 commented 10 months ago

I've also noticed that the page doesn't render the text correctly and has no horizontal scroll, meaning some text gets cut off. I'm using Firefox v117.0.1 and Chrome v116.0.5845.179.

Screenshot 2023-09-18 at 16 46 56
ajkyffin commented 10 months ago

There is a new release of Miredot (2.4.3-Java11) that supports JakartaEE.

ajkyffin commented 10 months ago

I've made a PR (#316) that updates Miredot, and I've used it to regenerate the docs for 6.0.0. I don't want to merge it yet because I want to avoid changing the scope of the jakartaee-api dependency if possible.