API document for opal-client and opal-server

[hongbo-miao]

I am wondering is there some API document for opal-client and opal-server that currently exposed?

I found https://opal.authorizon.com/redoc

• I know it is for authorizon.com, but I guess it is 100% apply to open source opal-server, right?
• I saw the version in the website is Opal Server (0.1.0), in Docker Hub, the latest opal-server version is 0.1.9, so not up-to-date?
• Is there any API document for opal-client too?

Thanks!

[asafc]

Hi @hongbo-miao :)

https://opal.authorizon.com is an opal-server running in production, it is not the latest version as we are currently working on the next version of our service.

The /redoc endpoint exposes the openapi schema of the service.

If you have opal server deployed at https://opal-server.hm:7002, the api docs are served at https://opal-server.hm:7002/redoc

Similarly if your opal client deployed at https://opal-client.hm:7000, the api docs for the client are served at https://opal-client.hm:7000/redoc

The api docs could definitely use some more work, we are working on it, is there something specific missing I should add to the list? :)

[hongbo-miao]

Oh nice! Missed it before. Just found it is also mentioned in the doc at https://docs.opal.ac/getting-started/get_started_with_opal_python_packages#simple-run-with-git-repo-watching

[hongbo-miao]

Hi @asafc

Currently I able to open these docs at

opal-client
http://localhost:7000/docs
http://localhost:7000/redoc

opal-server
http://localhost:7002/docs
http://localhost:7002/redoc

I am actually using opal-client and opal-server version 0.1.9 from Docker Hub.

However, seems in the UI, they all use 0.1.0.
It would be good to sync those API version in the docs with release / Docker image version.