openshift/genapidocs

Name: genapidocs

Owner: OpenShift

Description: null

Created: 2017-12-07 19:54:23.0

Updated: 2017-12-12 19:45:01.0

Pushed: 2017-12-12 20:13:21.0

Homepage: null

Size: 8593

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

genapidocs

Location of the OpenShift tool used to generate API docs.

Build
ke build 

Binary will be placed under _output/local/bin/genapidocs

Use
utput/local/bin/genapidocs --root=api-docs --base=<path/to/openshift/origin>

Generates api docs under ./api-docs.

--base is the relative path to the directory containing api/swagger-spec/openshift-openapi-spec.json

Update
 update-deps

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.