REST API: up to date? new routes? more explained examples?

Report a Bug
1

Hello everybody,

I would very much like to use your REST API, but I notice that it is not usable as it is currently documented ( REST — DATAGERRY 1.5.3 documentation ).

Examples:

  • I am missing a route to create a JSON web token to authenticate to the system.
  • Under “Frameworks” I would also expect a route for creating objects, e.g. to be able to automatically create objects in DataGerry via the Rest Api. A route for reading out would also make sense, because you might want to check via a script whether a certain entry already exists. Currently, the documentation only contains routes for “Categories” and “Types”.
  • The examples for the Rest Api are incomplete, see example Requests. It is not clear to me which data I actually have to send in a certain syntax.

What is the status of this and what do you have planned for the Rest Api in the future?

Many thanks in advance!

Best regards

2

Hi @anon60115798 ,
we are planning to improve the documentation on the API in the near future. The examples will be reevaluated and increased in quality.

BR Adnan

3

Any update on this? I stumbled upon /rest/auth/login by brute forcing. What is the endpoint to authenticate for JSON web token officially

4

I have to find routes in the API by brute forcing, this is not good guys, makes development really slow :slight_smile: I will open a pull request and help with the documentation in Github

5

Hi @Gateau,
there are upcoming changes to the API which will also include an updated version of the documentation.

This will happen in several steps/releases.

BR Adnan

6

Any news? Is there an OpenAPI doc set on the roadmap?

7

Hi @huke,
yes as part of the next release (in the very near future) the relevant routes will be documented in an OpenAPI format.

Sincerly,
Your DataGerry team