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

Add API reference docs from swagger #7

Open
discordianfish opened this issue Apr 4, 2019 · 4 comments
Open

Add API reference docs from swagger #7

discordianfish opened this issue Apr 4, 2019 · 4 comments

Comments

@discordianfish
Copy link

I think it would be super useful to have API docs on the site. Like https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/ they should get generated from the swagger definition.

@discordianfish
Copy link
Author

@rbreeze
Copy link
Member

rbreeze commented Jun 4, 2020

@discordianfish As I was looking at the REST docs earlier today I was thinking the same thing. Having them available without having to copy / paste into the Swagger editor would make it that much easier for people to access the docs and use the API. I'll try that script when I have a bit of free time.

@rbreeze
Copy link
Member

rbreeze commented Jun 4, 2020

It seems that script anticipates some of the documentation to be in AsciiDoc so I'm not sure it can be modified to work in this case. However, Swagger Codegen can generate static HTML from a Swagger doc (through several different methods) as per this StackOverflow post. I think the issue once the actual HTML generation itself is figured out is how to automate that generation upon swagger file changes.

@discordianfish
Copy link
Author

@jessesuen What do you think? ^

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

2 participants