kbe icon indicating copy to clipboard operation
kbe copied to clipboard

Published 20 hours ago • verified publisher icon openshift-evangelists

API spec reference for popular resources?

Open ryanj opened this issue 4 years ago • 1 comments

Consider parsing contents from the openAPI spec to generate markdown-based reference materials https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json

Would auto-generated content provide a better UX and improved SEO (compared to browsing the API using a swagger client)?

ryanj avatar Jun 25 '20 20:06 ryanj

@ryanj, I currently do this for the OCP 4.x API reference docs. The output is Asciidoc, however.

https://github.com/jboxman/openshift-apidocs-gen

jboxman avatar Jul 29 '20 02:07 jboxman