From d4156fe7f86a9231bf9d1cab34725ff548556481 Mon Sep 17 00:00:00 2001
From: Anne Gentle <annegentle@justwriteclick.com>
Date: Thu, 21 Jan 2016 08:11:44 -0600
Subject: [PATCH] Adds build script for Swagger JSON conversion

- This change lets us upload Swagger files for testing and
validating online.

Change-Id: Ifb570e42b29ec8f01889c982b7cd700754a0e5f7
---
 .gitignore                     |  1 +
 test-requirements.txt          |  1 +
 tools/build-api-ref-swagger.sh | 35 ++++++++++++++++++++++++++++++++++
 tox.ini                        |  7 +++++++
 4 files changed, 44 insertions(+)
 create mode 100755 tools/build-api-ref-swagger.sh

diff --git a/.gitignore b/.gitignore
index d9c9caed1..782bee75c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,6 +8,7 @@ target/
 /generated
 /api-quick-start/build/
 /firstapp/build*/
+swagger/
 
 # Packages
 *.egg
diff --git a/test-requirements.txt b/test-requirements.txt
index afafe8dbe..caa601004 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,3 +10,4 @@ sphinx>=1.3,!=1.3b1,<1.4
 openstackdocstheme>=1.2.3
 nwdiag
 sphinxcontrib-nwdiag
+fairy-slipper
diff --git a/tools/build-api-ref-swagger.sh b/tools/build-api-ref-swagger.sh
new file mode 100755
index 000000000..c35e53a33
--- /dev/null
+++ b/tools/build-api-ref-swagger.sh
@@ -0,0 +1,35 @@
+#!/bin/bash -xe
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+# fairy-slipper should be installed with test-requirements.txt
+# Migrate DocBook and WADL files to Swagger JSON
+
+function convert_to_swagger {
+    if [ ! -d swagger ]; then
+      mkdir swagger
+    fi
+
+    # Generate JSON
+    find api-ref/src/docbkx/ -name api-ref-\* -type f -exec fairy-slipper-docbkx-to-json -o swagger {} \;
+
+    # Generate Swagger
+    find swagger -name api-ref\*json -type f -exec fairy-slipper-wadl-to-swagger-valid -o swagger {} \;
+
+    # Remove interim JSON files
+    rm -r swagger/api-ref*
+
+}
+
+convert_to_swagger
diff --git a/tox.ini b/tox.ini
index 64cf2820c..a16bc95a4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -47,6 +47,11 @@ commands =
   # Build DocBook Guides
   openstack-doc-test --check-build {posargs}
 
+[testenv:makeswagger]
+commands =
+  # Build Swagger files
+  {toxinidir}/tools/build-api-ref-swagger.sh
+
 [testenv:publishdocs]
 # Prepare documents (without www) so that they can get published on
 # docs.openstack.org with just copying publish-docs/* over.
@@ -65,6 +70,8 @@ commands =
   {toxinidir}/tools/build-api-quick-start.sh
   # Build website index
   {toxinidir}/tools/build-index.sh publish
+  # Build RST/JSON from fairy-slipper
+  {toxinidir}/tools/build-api-ref-swagger.sh
 
 [testenv:checklang]
 # openstack-generate-docbook needs xml2po which cannot be installed in