nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Nuxeo REST API /doc endpoint missing in 2023 LTS

Zdeno_Franek

I cannot find anywhere info, if this endpoint was removed from Nuxeo. I have a problem that nuxeo-api-playground resource endpoints is throwing 404, also http://NUXEO_SERVER/nuxeo/site/automation/doc is not working. I noticed in github, that class:

@WebObject(type = "doc") DocObject

is no longer present in 2023 version. But if so, what is the new endpoint structure to access info about rest api endpoints? I cannot find info about this change anywhere in nuxeo documentation on the web.

Also why the nuxeo-api-playground in version 2023 do not reflect this change? Thanks for the clarification.

Find more posts tagged with

Accepted answers

Josh-F-Hyland

Playground not working is likely a CORS issue (https://doc.nuxeo.com/nxdoc/cross-origin-resource-sharing-cors/#examples) (though maybe not because you are running it "locally"?) Sorry I'm not sure, I deploy a CORS config in every demo so never really spend time on that issue.

EDIT: it turns out part of the API Playground was broken with HF18 so that may be related to your issue. The workaround is to install https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-rest-api-documentation (I know it's marked Deprecated, the product team is aware of the importance of an appropriate replacement)

Side note: you can also install packages at startup time using the NUXEO_PACKAGES env var. This just saves you the stop of rebuilding the image every time you want to change the packages but does make startup take a little longer. You are welcome to try our presales tooling if you want something more fleshed out, it's publicly available: https://github.com/nuxeo-sandbox/nuxeo-presales-docker

All comments

Josh-F-Hyland

That endpoint works fine for me on an LTS 2023 instance. I know this is the worst kind of answer ("it works for me") but I'm just posting to say it hasn't been removed, something else must be wrong, I'm just not sure what 😞

Zdeno_Franek

Thanks Josh for the reply. I am not really sure what have I done wrong, because I just created custom Docker image by extending base image with Dockerfile containing commands:

FROM docker-private.packages.nuxeo.com/nuxeo/nuxeo:2023
...
RUN /install-packages.sh --clid ${NUXEO_CLID} nuxeo-web-ui nuxeo-api-playground
...

After that I just run the container based on this image and playground is not working... Everything seems working fine except that /doc endpoint.

Josh-F-Hyland