diff options
author | Eric Debeau <eric.debeau@orange.com> | 2021-10-04 21:53:46 +0200 |
---|---|---|
committer | Eric Debeau <eric.debeau@orange.com> | 2021-10-14 15:01:46 +0000 |
commit | b25147b6a0e8313b26a22a932ff890b858fdbe3e (patch) | |
tree | 53337f4fcbf655bf6eac115ef331bd715cb56522 /docs/offeredapis/offeredapis.rst | |
parent | 7da7f2ced1347a94cd0d722c24da1f347ce54b11 (diff) |
[DOC] Correct ReDoc API documentationhonolulu
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
(cherry picked from commit 7471bd7e10998bc5cdfe591ed42b0f4c9eb41205)
Diffstat (limited to 'docs/offeredapis/offeredapis.rst')
-rw-r--r-- | docs/offeredapis/offeredapis.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index d383040..66f657e 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -16,9 +16,9 @@ NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be used by external systems as BSS for example. These API are based on **TMF API**. -******************************************* +******************************************** Global NBI architecture for Honolulu release -******************************************* +******************************************** Following illustration provides a global view about **NBI** architecture, integration with other ONAP components and API resource/operation provided. @@ -110,11 +110,11 @@ API Table 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>` +- `hub <./hub.html>`_ +- `serviceCatalog <./service_catalog.html>`_ +- `serviceInventory <./service_inventory.html>`_ +- `serviceOrder <./service_order.html>`_ +- `status <./status.html>`_ *************** |