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

Auto-document API endpoints with Swagger #38

Closed
phacks opened this issue Oct 21, 2019 · 0 comments · Fixed by #39
Closed

Auto-document API endpoints with Swagger #38

phacks opened this issue Oct 21, 2019 · 0 comments · Fixed by #39
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@phacks
Copy link
Contributor

phacks commented Oct 21, 2019

Falco offers a fully featured REST API, for which we need to write and update the documentation.

A few DRF-Swagger plugins are available, which would save us a lot of time in both writing and maintaining said documentation:

What would be even cooler is to integrate the documentation right inside the Docusaurus build for the docs, however it does not look possible at the moment.

@phacks phacks added the documentation Improvements or additions to documentation label Oct 21, 2019
@phacks phacks self-assigned this Oct 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant