Rename contiv.raml -> netmaster.raml, renamed RAML dirs, update RAML to refer to renamed dirs, contivModel2raml.rb now takes output file as an arg

Signed-off-by: Bill Robinson <[email protected]>

Author: dseevr

scripts/build.sh

@@ -6,13 +6,12 @@ set -euo pipefail
 bash generate.sh
 go install ./ ./client/
 
-# regenerate netmaster.raml
+# regenerate libraries/netmaster.raml which holds the type netmaster type data
 docker run --rm \
        -u $(id -u):$(id -g) \
        -v $(pwd):/files \
        -w /files/spec \
-       ruby:2.4.0-slim /usr/local/bin/ruby contivModel2raml.rb
-mv spec/netmaster.raml ./spec/contiv/libraries/netmaster.raml
+       ruby:2.4.0-slim /usr/local/bin/ruby contivModel2raml.rb ./netmaster/libraries/netmaster.raml
 
 # run the raml2html tool to generate docs under spec/docs
 pushd spec
@@ -28,6 +27,7 @@ if [[ "$(docker images -q $IMAGE_NAME:latest 2>/dev/null)" == "" ]]; then
     docker build -t $IMAGE_NAME -f spec/Dockerfile.cleanup .
 fi
 
+echo "Cleaning up HTML output"
 docker run --rm \
        -u $(id -u):$(id -g) \
        -v $(pwd):/files \

spec/auth_proxy.raml

@@ -12,10 +12,10 @@ protocols: [  HTTPS ]
 mediaType: [ application/json ]
 
 resourceTypes:
-  collection: !include contiv/schemas/collection.raml
-  non-upd-collection-item: !include contiv/schemas/non-upd-collection-item.raml
-  collection-item: !include contiv/schemas/collection-item.raml
-  ro-collection-item: !include contiv/schemas/ro-collection-item.raml
+  collection: !include auth_proxy/schemas/collection.raml
+  non-upd-collection-item: !include auth_proxy/schemas/non-upd-collection-item.raml
+  collection-item: !include auth_proxy/schemas/collection-item.raml
+  ro-collection-item: !include auth_proxy/schemas/ro-collection-item.raml
 
 annotationTypes:
   info:
@@ -27,11 +27,11 @@ annotationTypes:
   rediractable: boolean
 
 securitySchemes:
-  custom_scheme: !include contiv/schemas/custom-scheme.raml
+  custom_scheme: !include auth_proxy/schemas/custom-scheme.raml
 
 # Resource templates
 uses:
-  auth_proxy: contiv/libraries/auth_proxy.raml
+  auth_proxy: auth_proxy/libraries/auth_proxy.raml
 
 securedBy: custom_scheme
 

spec/build.sh

@@ -12,7 +12,7 @@ echo "generating netmaster docs"
 docker run --rm \
        -u $(id -u):$(id -g) \
        -v $(pwd):/contiv \
-       $IMAGE_NAME -i contiv.raml -o docs/contiv.html
+       $IMAGE_NAME -i netmaster.raml -o docs/contiv.html
 
 echo "generating auth_proxy docs"
 docker run --rm \

spec/contiv/libraries/auth_proxy.raml

@@ -9,7 +9,9 @@ def to_raml
   end
 end
 
-outfile = "netmaster.raml"
+raise "you must supply an output file, e.g., #{$PROGRAM_NAME} ./foo.raml" unless ARGV.size == 1
+
+outfile = ARGV[0]
 output = Hash.new { |h, k| h[k] = {} }
 
 Dir["../*.json"].each do |infile|

spec/contivModel2raml.rb

@@ -211,7 +211,7 @@
 <div class="page-header">
 <h1>Contiv API documentation <small>version v1</small>
 </h1>
-<p>http://{serverfqdn}:10000/api/{version}</p>
+<p>https://{serverfqdn}:10000/api/{version}</p>
 <ul>
 <li>
 <strong>serverfqdn</strong>: <em>required (string)</em>

spec/docs/auth_proxy.html

@@ -12,10 +12,10 @@ protocols: [  HTTPS ]
 mediaType: [ application/json ]
 
 resourceTypes:
-  collection: !include contiv/schemas/collection.raml
-  non-upd-collection-item: !include contiv/schemas/non-upd-collection-item.raml
-  collection-item: !include contiv/schemas/collection-item.raml
-  ro-collection-item: !include contiv/schemas/ro-collection-item.raml
+  collection: !include netmaster/schemas/collection.raml
+  non-upd-collection-item: !include netmaster/schemas/non-upd-collection-item.raml
+  collection-item: !include netmaster/schemas/collection-item.raml
+  ro-collection-item: !include netmaster/schemas/ro-collection-item.raml
 
 annotationTypes:
   info:
@@ -27,11 +27,11 @@ annotationTypes:
   rediractable: boolean
 
 securitySchemes:
-  custom_scheme: !include contiv/schemas/custom-scheme.raml
+  custom_scheme: !include netmaster/schemas/custom-scheme.raml
 
 # Resource templates
 uses:
-  netmaster: contiv/libraries/netmaster.raml
+  netmaster: netmaster/libraries/netmaster.raml
 
 securedBy: custom_scheme