From 78b0ab8c410c9d4c79a98e3a71fe635c028f4785 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Thu, 16 Apr 2020 14:14:08 +0200 Subject: [PATCH] WIP: add embedded ReDoc documentation for API Include ReDoc using embedded JavaScript capabilities in RST Create a new directory 'redoc' to store - .rst to embed RST content for each 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 Change-Id: Iaa2430a7d4080ed6f91ec8a3e2d6203319f29425 --- docs/offeredapis/offeredapis.rst | 11 +++++++++++ docs/offeredapis/redoc/api_hub.js | 1 + docs/offeredapis/redoc/api_hub.rst | 9 +++++++++ docs/offeredapis/redoc/api_serviceCatalog.js | 1 + docs/offeredapis/redoc/api_serviceCatalog.rst | 9 +++++++++ docs/offeredapis/redoc/api_serviceInventory.js | 1 + docs/offeredapis/redoc/api_serviceInventory.rst | 9 +++++++++ docs/offeredapis/redoc/api_serviceOrder.js | 1 + docs/offeredapis/redoc/api_serviceOrder.rst | 9 +++++++++ docs/offeredapis/redoc/api_status.js | 1 + docs/offeredapis/redoc/api_status.rst | 9 +++++++++ docs/offeredapis/redoc/redoc.js | 1 + 12 files changed, 62 insertions(+) create mode 100644 docs/offeredapis/redoc/api_hub.js create mode 100644 docs/offeredapis/redoc/api_hub.rst create mode 100644 docs/offeredapis/redoc/api_serviceCatalog.js create mode 100644 docs/offeredapis/redoc/api_serviceCatalog.rst create mode 100644 docs/offeredapis/redoc/api_serviceInventory.js create mode 100644 docs/offeredapis/redoc/api_serviceInventory.rst create mode 100644 docs/offeredapis/redoc/api_serviceOrder.js create mode 100644 docs/offeredapis/redoc/api_serviceOrder.rst create mode 100644 docs/offeredapis/redoc/api_status.js create mode 100644 docs/offeredapis/redoc/api_status.rst create mode 100644 docs/offeredapis/redoc/redoc.js diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 342b09a..02817f3 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -94,6 +94,17 @@ API Table "serviceOrder", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" "status", ":download:`link `", ":download:`link `", ":download:`link `", ":download:`link `" +*********************** +API ReDoc Documentation +*********************** + +* :doc:`API hub ` +* :doc:`Service Catalog ` +* :doc:`Service Inventory ` +* :doc:`Service Order ` +* :doc:`Status ` + + *************** API Description *************** diff --git a/docs/offeredapis/redoc/api_hub.js b/docs/offeredapis/redoc/api_hub.js new file mode 100644 index 0000000..271655e --- /dev/null +++ b/docs/offeredapis/redoc/api_hub.js @@ -0,0 +1 @@ + \ 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 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 index 0000000..e221c13 --- /dev/null +++ b/docs/offeredapis/redoc/api_serviceCatalog.js @@ -0,0 +1 @@ + \ 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 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 index 0000000..1b73a06 --- /dev/null +++ b/docs/offeredapis/redoc/api_serviceInventory.js @@ -0,0 +1 @@ + \ 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 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 index 0000000..680a5e4 --- /dev/null +++ b/docs/offeredapis/redoc/api_serviceOrder.js @@ -0,0 +1 @@ + \ 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 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 index 0000000..634c856 --- /dev/null +++ b/docs/offeredapis/redoc/api_status.js @@ -0,0 +1 @@ + \ 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 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 index 0000000..08ffbaa --- /dev/null +++ b/docs/offeredapis/redoc/redoc.js @@ -0,0 +1 @@ + \ No newline at end of file -- 2.16.6