From 78b0ab8c410c9d4c79a98e3a71fe635c028f4785 Mon Sep 17 00:00:00 2001
From: Eric Debeau <eric.debeau@orange.com>
Date: Thu, 16 Apr 2020 14:14:08 +0200
Subject: 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
---
 docs/offeredapis/offeredapis.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'docs/offeredapis/offeredapis.rst')

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 <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
 ***************
-- 
cgit 1.2.3-korg