WIP: add embedded ReDoc documentation for API

Include ReDoc using embedded JavaScript capabilities in RST

Create a new directory 'redoc' to store
- <api>.rst to embed RST content for each API
- <api>.js to store link towards the JSON Swagger file for each API
- redoc.js to store JS links to render ReDoc

Modify offeredapis.rst to include a new section

Issue-ID: EXTAPI-433

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Iaa2430a7d4080ed6f91ec8a3e2d6203319f29425

diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index 342b09a..02817f3 100644 (file)
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -94,6 +94,17 @@ API Table
    "serviceOrder", ":download:`link <api_serviceOrder/swagger.json>`", ":download:`link <api_serviceOrder/swagger.yaml>`", ":download:`link <api_serviceOrder/api.plantuml>`", ":download:`link <api_serviceOrder/model.xsd>`"
    "status", ":download:`link <api_status/swagger.json>`", ":download:`link <api_status/swagger.yaml>`", ":download:`link <api_status/api.plantuml>`", ":download:`link <api_status/model.xsd>`"
 
+***********************
+API ReDoc Documentation
+***********************
+
+* :doc:`API hub <redoc/api_hub>`
+* :doc:`Service Catalog <redoc/api_serviceCatalog>`
+* :doc:`Service Inventory <redoc/api_serviceInventory>`
+* :doc:`Service Order <redoc/api_serviceOrder>`
+* :doc:`Status <redoc/api_status>`
+
+
 ***************
 API Description
 ***************

diff --git a/docs/offeredapis/redoc/api_hub.js b/docs/offeredapis/redoc/api_hub.js
new file mode 100644 (file)
index 0000000..271655e
--- /dev/null
+++ b/docs/offeredapis/redoc/api_hub.js
@@ -0,0 +1 @@
+<redoc spec-url='https://docs.onap.org/en/latest/_downloads/0e070a6a43ca19bec86d24ffc669044a/swagger.json'></redoc>
\ No newline at end of file

diff --git a/docs/offeredapis/redoc/api_hub.rst b/docs/offeredapis/redoc/api_hub.rst
new file mode 100644 (file)
index 0000000..95e77fe
--- /dev/null
+++ b/docs/offeredapis/redoc/api_hub.rst
@@ -0,0 +1,9 @@
+=======
+API Hub
+=======
+
+.. raw:: html
+   :file: api_hub.js
+
+.. raw:: html
+   :file: redoc.js

diff --git a/docs/offeredapis/redoc/api_serviceCatalog.js b/docs/offeredapis/redoc/api_serviceCatalog.js
new file mode 100644 (file)
index 0000000..e221c13
--- /dev/null
+++ b/docs/offeredapis/redoc/api_serviceCatalog.js
@@ -0,0 +1 @@
+<redoc spec-url='https://docs.onap.org/en/latest/_downloads/71d4941522ad03797c654eeee4bd89fa/swagger.json'></redoc>
\ No newline at end of file

diff --git a/docs/offeredapis/redoc/api_serviceCatalog.rst b/docs/offeredapis/redoc/api_serviceCatalog.rst
new file mode 100644 (file)
index 0000000..872305f
--- /dev/null
+++ b/docs/offeredapis/redoc/api_serviceCatalog.rst
@@ -0,0 +1,9 @@
+===================
+API Service Catalog
+===================
+
+.. raw:: html
+   :file: api_serviceCatalog.js
+
+.. raw:: html
+   :file: redoc.js

diff --git a/docs/offeredapis/redoc/api_serviceInventory.js b/docs/offeredapis/redoc/api_serviceInventory.js
new file mode 100644 (file)
index 0000000..1b73a06
--- /dev/null
+++ b/docs/offeredapis/redoc/api_serviceInventory.js
@@ -0,0 +1 @@
+<redoc spec-url='https://docs.onap.org/en/latest/_downloads/93273217aeaa407241a355e679c844b4/swagger.json'></redoc>
\ No newline at end of file

diff --git a/docs/offeredapis/redoc/api_serviceInventory.rst b/docs/offeredapis/redoc/api_serviceInventory.rst
new file mode 100644 (file)
index 0000000..36c11c3
--- /dev/null
+++ b/docs/offeredapis/redoc/api_serviceInventory.rst
@@ -0,0 +1,9 @@
+=====================
+API Service Inventory
+=====================
+
+.. raw:: html
+   :file: api_serviceInventory.js
+
+.. raw:: html
+   :file: redoc.js

diff --git a/docs/offeredapis/redoc/api_serviceOrder.js b/docs/offeredapis/redoc/api_serviceOrder.js
new file mode 100644 (file)
index 0000000..680a5e4
--- /dev/null
+++ b/docs/offeredapis/redoc/api_serviceOrder.js
@@ -0,0 +1 @@
+<redoc spec-url='https://docs.onap.org/en/latest/_downloads/df16d15107ad648ac513dedf3da4f0e5/swagger.json'></redoc>
\ No newline at end of file

diff --git a/docs/offeredapis/redoc/api_serviceOrder.rst b/docs/offeredapis/redoc/api_serviceOrder.rst
new file mode 100644 (file)
index 0000000..792fb47
--- /dev/null
+++ b/docs/offeredapis/redoc/api_serviceOrder.rst
@@ -0,0 +1,9 @@
+=================
+API Service Order
+=================
+
+.. raw:: html
+   :file: api_serviceOrder.js
+
+.. raw:: html
+   :file: redoc.js

diff --git a/docs/offeredapis/redoc/api_status.js b/docs/offeredapis/redoc/api_status.js
new file mode 100644 (file)
index 0000000..634c856
--- /dev/null
+++ b/docs/offeredapis/redoc/api_status.js
@@ -0,0 +1 @@
+<redoc spec-url='https://docs.onap.org/en/latest/_downloads/d82274385015de7be0ba6f3a8e54a673/swagger.json'></redoc>
\ No newline at end of file

diff --git a/docs/offeredapis/redoc/api_status.rst b/docs/offeredapis/redoc/api_status.rst
new file mode 100644 (file)
index 0000000..fc6acbb
--- /dev/null
+++ b/docs/offeredapis/redoc/api_status.rst
@@ -0,0 +1,9 @@
+==========
+API Status
+==========
+
+.. raw:: html
+   :file: api_status.js
+
+.. raw:: html
+   :file: redoc.js

diff --git a/docs/offeredapis/redoc/redoc.js b/docs/offeredapis/redoc/redoc.js
new file mode 100644 (file)
index 0000000..08ffbaa
--- /dev/null
+++ b/docs/offeredapis/redoc/redoc.js
@@ -0,0 +1 @@
+<script src="https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js"> </script>
\ No newline at end of file