Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework Auth API documentation #602

Closed
kovetskiy opened this issue Sep 18, 2018 · 2 comments
Closed

Rework Auth API documentation #602

kovetskiy opened this issue Sep 18, 2018 · 2 comments

Comments

@kovetskiy
Copy link

https://github.com/rubykube/barong/blob/master/docs/api/api.md#postv1securityrenew

For some reason Auth API's docs look very ugly, instead of beautiful headers like in Management API:

POST /management_api/v1/otp/sign
Summary: Sign request with barong signature

in Auth's API we have postV1SecurityGenerateQrcode, it should be reworked and must have the same format as in Management API.

@rxx
Copy link

rxx commented Oct 3, 2018

I think both formats of API are ugly. But first one is ugly only in text variant. It's format for server rendered docs and it's awesome. The problem that we have no public api doc server

@ec
Copy link
Contributor

ec commented Oct 24, 2018

Postponed

@ec ec closed this as completed Oct 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants