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

Enhance API interface description with OpenAPI/Swagger/xyz format #6

Open
hb-tpfister opened this issue May 9, 2019 · 0 comments
Open
Assignees

Comments

@hb-tpfister
Copy link

In addition to your existing documentation it would be nice if you could provide the API interface descriptions in a standard format like OpenAPI / Swagger (or if you are using something else internally already, that). Benefits include a quick overview with technical details, possibilities to use client generators (which may need minor adjustments), etc.

This would either be possible via this repository or if you prefer as a living documentation on a new API endpoint of yours.

Thanks for considering!

@lmmendes lmmendes self-assigned this Jun 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants