aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/redoc
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2021-10-04 21:53:46 +0200
committerEric Debeau <eric.debeau@orange.com>2021-10-04 21:57:52 +0200
commit7471bd7e10998bc5cdfe591ed42b0f4c9eb41205 (patch)
tree53337f4fcbf655bf6eac115ef331bd715cb56522 /docs/offeredapis/redoc
parentfe84d8f5a984880535eda8a1bba95bba096d09d1 (diff)
[DOC] Correct ReDoc API documentation
Existing solution based on javascript is not working - solution based on _downloads reference Use sphinxcontrib-redoc package - Update conf.py to add the required extensions - Update conf.py to add ReDoc API documentation - Add sphinxcontrib-redoc in requirements-docs.txt - Remove redoc directory - Copy Swagger JSON file in swagger repo - Rename Swagger JSON file - Correct Swagger JSON file to delete bad characters Small editorial corrections - Update doc/architecture.rst Issue-ID: EXTAPI-599 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I3c2b52ff072f81f5554046498f0cf8419cc3f342
Diffstat (limited to 'docs/offeredapis/redoc')
-rw-r--r--docs/offeredapis/redoc/api_hub.js1
-rw-r--r--docs/offeredapis/redoc/api_hub.rst9
-rw-r--r--docs/offeredapis/redoc/api_serviceCatalog.js1
-rw-r--r--docs/offeredapis/redoc/api_serviceCatalog.rst9
-rw-r--r--docs/offeredapis/redoc/api_serviceInventory.js1
-rw-r--r--docs/offeredapis/redoc/api_serviceInventory.rst9
-rw-r--r--docs/offeredapis/redoc/api_serviceOrder.js1
-rw-r--r--docs/offeredapis/redoc/api_serviceOrder.rst9
-rw-r--r--docs/offeredapis/redoc/api_status.js1
-rw-r--r--docs/offeredapis/redoc/api_status.rst9
-rw-r--r--docs/offeredapis/redoc/redoc.js1
11 files changed, 0 insertions, 51 deletions
diff --git a/docs/offeredapis/redoc/api_hub.js b/docs/offeredapis/redoc/api_hub.js
deleted file mode 100644
index 9531a4d..0000000
--- a/docs/offeredapis/redoc/api_hub.js
+++ /dev/null
@@ -1 +0,0 @@
-<redoc spec-url='https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/7b81c97fc19ddb7f1c31168f77957612/swagger.json'></redoc>
diff --git a/docs/offeredapis/redoc/api_hub.rst b/docs/offeredapis/redoc/api_hub.rst
deleted file mode 100644
index 95e77fe..0000000
--- a/docs/offeredapis/redoc/api_hub.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-=======
-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
deleted file mode 100644
index 58cc5ca..0000000
--- a/docs/offeredapis/redoc/api_serviceCatalog.js
+++ /dev/null
@@ -1 +0,0 @@
-<redoc spec-url='https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/ebe32f7b0f44f37226c71cfbcc0e1a72/swagger.json'></redoc>
diff --git a/docs/offeredapis/redoc/api_serviceCatalog.rst b/docs/offeredapis/redoc/api_serviceCatalog.rst
deleted file mode 100644
index 872305f..0000000
--- a/docs/offeredapis/redoc/api_serviceCatalog.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-===================
-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
deleted file mode 100644
index 9098afc..0000000
--- a/docs/offeredapis/redoc/api_serviceInventory.js
+++ /dev/null
@@ -1 +0,0 @@
-<redoc spec-url='https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/2366f0bdc6bb6f4d162f2825288ced96/swagger.json'></redoc>
diff --git a/docs/offeredapis/redoc/api_serviceInventory.rst b/docs/offeredapis/redoc/api_serviceInventory.rst
deleted file mode 100644
index 36c11c3..0000000
--- a/docs/offeredapis/redoc/api_serviceInventory.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-=====================
-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
deleted file mode 100644
index 5911168..0000000
--- a/docs/offeredapis/redoc/api_serviceOrder.js
+++ /dev/null
@@ -1 +0,0 @@
-<redoc spec-url='https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/8570180cc7118dafa09f7a5989d94e6f/swagger.json'></redoc>
diff --git a/docs/offeredapis/redoc/api_serviceOrder.rst b/docs/offeredapis/redoc/api_serviceOrder.rst
deleted file mode 100644
index 792fb47..0000000
--- a/docs/offeredapis/redoc/api_serviceOrder.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-=================
-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
deleted file mode 100644
index 2617a38..0000000
--- a/docs/offeredapis/redoc/api_status.js
+++ /dev/null
@@ -1 +0,0 @@
-<redoc spec-url='https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/_downloads/32f58fbdbdc8b7960948036f1aab7deb/swagger.json'></redoc>
diff --git a/docs/offeredapis/redoc/api_status.rst b/docs/offeredapis/redoc/api_status.rst
deleted file mode 100644
index fc6acbb..0000000
--- a/docs/offeredapis/redoc/api_status.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-==========
-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
deleted file mode 100644
index 08ffbaa..0000000
--- a/docs/offeredapis/redoc/redoc.js
+++ /dev/null
@@ -1 +0,0 @@
-<script src="https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js"> </script> \ No newline at end of file