diff options
| author |   Eric Debeau <eric.debeau@orange.com> | 2020-04-16 14:14:08 +0200 |
|---|---|---|
| committer | Eric Debeau <eric.debeau@orange.com> | 2020-04-16 14:33:32 +0200 |
| commit | 78b0ab8c410c9d4c79a98e3a71fe635c028f4785 (patch) | |
| tree | 855ab5f046db0930d083f980e9a0356373090c6a /docs/offeredapis/offeredapis.rst | |
| parent | 86f0fd6ce609d5cf496ce4bb22656fb1ceb43c54 (diff) | |
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
Diffstat (limited to 'docs/offeredapis/offeredapis.rst')
| -rw-r--r-- | docs/offeredapis/offeredapis.rst | 11 |
1 files changed, 11 insertions, 0 deletions
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 *************** |