Browse code

update swagger dev README with updated script name

Aaron Weitekamp authored on 2016/08/23 04:19:31
Showing 1 changed files
... ...
@@ -12,13 +12,13 @@ When you add a new object or field to the REST API, you should do the following:
12 12
 
13 13
 To generate the docs, you need gradle 2.2+ installed, then run
14 14
 
15
-    $ hack/gen-swagger-docs.sh
15
+    $ hack/update-swagger-docs.sh
16 16
 
17 17
 That will create docs into _output/local/docs/swagger/api/v1 and oapi/v1 for the Kube and OpenShift docs.
18 18
 
19
-From openshift-docs you can generate these directly in one step - make the changes to the OpenShift origin repo (like adding descriptions or generating new swagger doc), then run
19
+From the openshift-docs source repo you can generate these directly in one step after making the changes to the OpenShift origin repo (like adding descriptions or generating new swagger doc). The following assumes both origin and openshift-docs repos are at the same level in the directory structure. If not, use the environment variable *`ORIGIN_REPO`* to define the path to the origin source repo.
20 20
 
21 21
     $ cd ../openshift-docs
22 22
     $ rake import_api
23 23
 
24
-This will invoke gen-swagger-docs.sh and import the API into rest_api/.  After importing you'll need to add the correct adoc metadata to the top of kubernetes_v1.adoc and openshift_v1.adoc (pulls to automate that welcome).
24
+This will invoke update-swagger-docs.sh and import the API into rest_api/.  After importing you'll need to add the correct adoc metadata to the top of kubernetes_v1.adoc and openshift_v1.adoc (pulls to automate that welcome).