photon icon indicating copy to clipboard operation
photon copied to clipboard

Provide OpenAPI specs

Open debuglevel opened this issue 3 years ago • 2 comments

It would be nice if the API provides an endpoint to an OpenAPI specification. This would facilitate code generation for client libraries.

Unfortunately - if Spark did not change much since I used it - it does not support this out of the box. Therefore it would require manual work. There is also https://github.com/manusant/spark-swagger, but I never tried it back then.

debuglevel avatar Mar 17 '21 06:03 debuglevel

Here is the OpenAPI Spec we use https://gist.github.com/KiwiKilian/1f9d35544a7e9312bb74bd75a889df9c.

I don't know anything about spark, therefore I could only contribute the manually created spec. But at least some Swagger UI would be necessary for proper display in the Docs?

KiwiKilian avatar Feb 01 '24 15:02 KiwiKilian