guardian icon indicating copy to clipboard operation
guardian copied to clipboard

Published 20 hours ago • verified publisher icon raystack

Expose swagger UI

Open bsushmith opened this issue 2 years ago • 4 comments

Summary Expose swagger UI: It would be helpful to interact with the guardian server through API way if there's a swagger UI exposed through the grpc-gateway.

Proposed solution How will it benefit CLI and its users? CLI already has a help command set to work with. This feature request is specifically to enhance the usage of the API way.

bsushmith avatar Aug 27 '22 16:08 bsushmith

This can be helpful in the dev and staging environments. But I think we should not expose this in a production environment. So, IMO it should be configurable.

ravisuhag avatar Aug 27 '22 16:08 ravisuhag

This can also be extracted as a package in salt to make it reusable.

ravisuhag avatar Sep 21 '22 20:09 ravisuhag

Swagger UI can be hosted anywhere provided the swagger file is available. We should make that public in the repo and swagger UI can read it and render it. IMO It shouldn't be added to the application code.

AkarshSatija avatar Sep 22 '22 10:09 AkarshSatija

@AkarshSatija fair point. +1

ravisuhag avatar Sep 22 '22 10:09 ravisuhag