search

eclipse-apoapsis / ort-server

A scalable server implementation of the OSS Review Toolkit.
https://eclipse-apoapsis.github.io/ort-server/
Apache License 2.0
17 stars 8 forks source link

Publish the Swagger UI (to GitHub pages) #94

Open sschuberth opened 5 months ago

sschuberth commented 5 months ago

It would be convenient to have the Swagger UI available without building the project locally, so auto-publishing the latest Swagger UI e.g. to GitHub pages would be great. Maybe these projects could help:

Etsija commented 5 months ago

I second this, would be helpful to see and inspect the API even without building the project.

Etsija commented 5 months ago

Now as our initial Server UI is in the codebase, we would really need this for planning the way forward; access to the API spec via GitHub would be very beneficial, as not everyone in our team wants to always run the local setup just to be able to inspect the API.

sschuberth commented 1 month ago

@mnonnenmacher is there a way to prioritize this? This would be really convenient for front-end development still.

mnonnenmacher commented 1 month ago

I thought the frontend devs would now always have the compose setup running anyway?

sschuberth commented 1 month ago

Mostly, yes, but as you know there are still issues with the Compose setup, and for quickly looking up something it'd be more convenient to have a public reference. But I just realized I could also just use Swagger from our staging deployment.

mnonnenmacher commented 1 month ago

I have done some testing with https://github.com/PaloAltoNetworks/docusaurus-openapi-docs and it looks promising:

grafik

It currently fails for some endpoints due to invalid specs, but once #946 is merged I will look into adding this.