[DOC] Correct ReDoc API documentation 73/124673/1
authorEric Debeau <eric.debeau@orange.com>
Mon, 4 Oct 2021 19:53:46 +0000 (21:53 +0200)
committerEric Debeau <eric.debeau@orange.com>
Mon, 4 Oct 2021 19:57:52 +0000 (21:57 +0200)
commit7471bd7e10998bc5cdfe591ed42b0f4c9eb41205
tree53337f4fcbf655bf6eac115ef331bd715cb56522
parentfe84d8f5a984880535eda8a1bba95bba096d09d1
[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
21 files changed:
docs/.gitignore
docs/architecture/architecture.rst
docs/conf.py
docs/offeredapis/offeredapis.rst
docs/offeredapis/redoc/api_hub.js [deleted file]
docs/offeredapis/redoc/api_hub.rst [deleted file]
docs/offeredapis/redoc/api_serviceCatalog.js [deleted file]
docs/offeredapis/redoc/api_serviceCatalog.rst [deleted file]
docs/offeredapis/redoc/api_serviceInventory.js [deleted file]
docs/offeredapis/redoc/api_serviceInventory.rst [deleted file]
docs/offeredapis/redoc/api_serviceOrder.js [deleted file]
docs/offeredapis/redoc/api_serviceOrder.rst [deleted file]
docs/offeredapis/redoc/api_status.js [deleted file]
docs/offeredapis/redoc/api_status.rst [deleted file]
docs/offeredapis/redoc/redoc.js [deleted file]
docs/offeredapis/swagger/hub.json [new file with mode: 0644]
docs/offeredapis/swagger/service_catalog.json [new file with mode: 0644]
docs/offeredapis/swagger/service_inventory.json [new file with mode: 0644]
docs/offeredapis/swagger/service_order.json [new file with mode: 0644]
docs/offeredapis/swagger/status.json [new file with mode: 0644]
docs/requirements-docs.txt