Code Review / externalapi / nbi.git / commit
? search:
summary | shortlog | log | commit | commitdiff | review | tree
(parent: 86f0fd6) | patch
WIP: add embedded ReDoc documentation for API 98/106098/1
authorEric Debeau <eric.debeau@orange.com>
Thu, 16 Apr 2020 12:14:08 +0000 (14:14 +0200)
committerEric Debeau <eric.debeau@orange.com>
Thu, 16 Apr 2020 12:33:32 +0000 (14:33 +0200)
commit78b0ab8c410c9d4c79a98e3a71fe635c028f4785
tree855ab5f046db0930d083f980e9a0356373090c6atree | snapshot
parent86f0fd6ce609d5cf496ce4bb22656fb1ceb43c54commit | 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
12 files changed:
docs/offeredapis/offeredapis.rst diff | blob | history
docs/offeredapis/redoc/api_hub.js [new file with mode: 0644] blob
docs/offeredapis/redoc/api_hub.rst [new file with mode: 0644] blob
docs/offeredapis/redoc/api_serviceCatalog.js [new file with mode: 0644] blob
docs/offeredapis/redoc/api_serviceCatalog.rst [new file with mode: 0644] blob
docs/offeredapis/redoc/api_serviceInventory.js [new file with mode: 0644] blob
docs/offeredapis/redoc/api_serviceInventory.rst [new file with mode: 0644] blob
docs/offeredapis/redoc/api_serviceOrder.js [new file with mode: 0644] blob
docs/offeredapis/redoc/api_serviceOrder.rst [new file with mode: 0644] blob
docs/offeredapis/redoc/api_status.js [new file with mode: 0644] blob
docs/offeredapis/redoc/api_status.rst [new file with mode: 0644] blob
docs/offeredapis/redoc/redoc.js [new file with mode: 0644] blob
ARCHIVED- 2022-02-15 at the request of the project