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

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

Closed
RKrahl opened this issue Jul 26, 2023 · 4 comments · Fixed by #316
Closed

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

RKrahl opened this issue Jul 26, 2023 · 4 comments · Fixed by #316

Comments

@RKrahl
Copy link
Member

RKrahl commented Jul 26, 2023

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
Copy link
Contributor

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
Copy link

moonraker595 commented Sep 18, 2023

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
Copy link
Contributor

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

@ajkyffin
Copy link
Contributor

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.

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

Successfully merging a pull request may close this issue.

3 participants