List all senaite.jsonapi routes


#1

Hello everyone,

I need a complete list of all available routes in senaite.jsonapi.

From Plone api doc, which is familiar to senaite’s api, I could guess some working routes, e.g.
‘localhost:8080/senaite/@@API/senaite/v1/search?portal_type=Client’

Is there an overview of all registered routes in senaite?


#2

Hello @CeiHeel8

Basically senaite.jsonapi supports all content objects of Senaite by specifying the portal_type name after the base URL /@@API/senaite/v1/, e.g. /@@API/senaite/v1/client, /@@API/senaite/v1/analysisservice, analysisrequest etc.

Unfortunately there is no listing of all available routes yet, but you can look into the code here:


and check the @add_route decorators to see what routes are registered.

For example @add_route("/registry", "senaite.jsonapi.v1.registry", methods=["GET"]) means that there is a route registered at /@@API/senaite/v1/registry or
@add_route("/users", "senaite.jsonapi.v1.users", methods=["GET"]) means that there is a route registered at /@@API/senaite/v1/users

Best regards, Ramon