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

better api documentation #36

Open
AubreyHewes opened this issue Oct 14, 2019 · 0 comments
Open

better api documentation #36

AubreyHewes opened this issue Oct 14, 2019 · 0 comments

Comments

@AubreyHewes
Copy link
Member

The api documentation in the readme is slightly confusing and non descriptive, we should make this more intuitive..

i.e. maybe more markdown, method descriptions based on the CB openapi specification..?

possibly generated... from the (blueprint) spec...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant