github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/hack/gen-swagger-doc
History
supereagle 606c32bc92 correct the script name for generating swagger doc 2017-06-09 14:25:32 +08:00
..
example-output Fix type-o in definitions.html 2016-06-08 14:22:16 +10:00
Dockerfile update url information to prevent http 304 redirection 2017-05-25 14:05:02 +08:00
README.md correct the script name for generating swagger doc 2017-06-09 14:25:32 +08:00
build.gradle
…
gen-swagger-docs.sh change the relative links to definition in operations.html to satisfy the new path set in the kubernetes.io 2016-07-29 13:29:34 -07:00

README.md

This folder contains the sources needed to build the gen-swagger-doc container.

To build the container image,

$ sudo docker build -t gcr.io/google_containers/gen-swagger-docs:v1 .

To generate the html docs,

$ ./gen-swagger-docs.sh <API version> <absolute output path, default to PWD>

The generated definitions.html and operations.html will be stored in output paths.

Analytics