Detailed API reference

[Antonio Madonna]

Hello, I'm looking for a detailed orthanc API reference. 

The one linked here https://www.orthanc-server.com/static.php?page=documentation only lists the endpoints, but gives no info about params accepted.

Thanks for any help

Antonio

[Yvens Reboucas]

Do you mean this API: http://sdk.orthanc-server.com/ ?

Other than that, you can browse here http://book.orthanc-server.com/index.html.

[Aditya Panchal]

We talked about this in a past thread, but eventually there should be Swagger/OpenAPI documentation ( https://swagger.io/ ) for the Orthanc endpoints.

I am not sure what is the status from the Orthanc developers, but I started some work on it, but it's far from complete.

I think the first step is to list all the endpoints and put into Swagger/OpenAPI format. One could use: https://editor.swagger.io/ to start.

Then with the help of the developers, we can determine all the parameters.

Eventually once it is set up, this is something that could be auto-generated / updated by the source itself.

In the end I would assume this would replace the Google sheet of endpoints.

[Sébastien Jodogne]

Dear Aditya,

We fully agree with the fact that an OpenAPI documentation would be a very important addition to Orthanc. This task is now added to our roadmap:

https://bitbucket.org/sjodogne/orthanc/commits/716e7d07e69d8ad76fe261c73d008beaee554c84

Have you already started some work on this topic? If so, is it available somewhere?

Regards,

Sébastien-

[Aditya Panchal]

Dear Sébastien,

Please find the following GitHub repository with a first draft of the Orthanc OpenAPI specification (OpenAPI v2): https://github.com/bastula/swagger-orthanc

I have listed all the major tags representing the different major endpoints from the Orthanc REST API.

As you know, it will take some time to fully flesh out the OpenAPI specficiation.

Currently, it has a complete working spec of the /changes endpoint.

I think via community contribution via forks (and any free time that I have) we can complete this task.

I think as Orthanc project lead, you should audit the spec and make any necessary changes you feel that are relevant. There are a number of additional objects and fields that could be implemented in the spec that I have chosen not to include for the sake of brevity.

Best,

Aditya