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

Make openapi doc human readable #9

Open
apomalyn opened this issue Apr 4, 2022 · 3 comments
Open

Make openapi doc human readable #9

apomalyn opened this issue Apr 4, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@apomalyn
Copy link
Member

apomalyn commented Apr 4, 2022

As a developer, I would like to read easily the openapi documentation.

Proposition

Using GitHub pages, and this you can make the YAML file pretty 😉

@apomalyn apomalyn added the documentation Improvements or additions to documentation label Apr 4, 2022
@MysticFragilist
Copy link
Contributor

Good idea! Right now when you launch the app in debug, you can see the documentation popping up automatically. Though integrating it through a github pages would be really cool!
image

Also, I think your link is not working, maybe the repo is private? 😄

@apomalyn
Copy link
Member Author

Oops 😅 sorry ahah this one should be good 😄 and the GitHub pages associated with it is here the UI can be changed of course to look like Swagger or OpenApi as wish of course

@MysticFragilist
Copy link
Contributor

This should be handled with the deployment. It won't be on GitHub pages but will be accessible through the API. Will close when it's deployed and tested :)

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

No branches or pull requests

2 participants