aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorlapentafd <francesco.lapenta@est.tech>2023-03-27 13:46:04 +0100
committerFrancesco Davide Lapenta <francesco.lapenta@est.tech>2023-04-04 14:31:45 +0000
commita43eb545dded63e1f21b7f14105ae0ed093b54db (patch)
tree54d965ae22f9ed6c39a2d978632ecb0158c3ca16 /docs/conf.py
parenta174cadc174377c9c38df860d7e37b5799067bc7 (diff)
Update Policy Offered APIs
Swagger documentation rendered in ReDoc webpage. The html page is generated during the Sphinx build. The sphinx.builders.linkcheck reports as false positives the links that are generated dynamically, such as with the sphinxcontrib-redoc extension. Issue-ID: POLICY-4581 Change-Id: I9b720b961332689b144d5fe9d8be82be436d1c16 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py49
1 files changed, 47 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 0c28118e..3e04bef9 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -23,7 +23,51 @@ extensions = [
'sphinxcontrib.seqdiag',
'sphinxcontrib.swaggerdoc',
'sphinxcontrib.plantuml',
- 'sphinx_toolbox.collapse'
+ 'sphinx_toolbox.collapse',
+ 'sphinxcontrib.redoc'
+]
+
+redoc = [
+ {
+ 'name': 'Policy API',
+ 'page': 'api/local-swagger',
+ 'spec': 'https://raw.githubusercontent.com/onap/policy-api/master/main/src/main/resources/openapi/openapi.yaml',
+ 'opts': {
+ 'lazy-rendering': True,
+ 'suppress-warnings': True,
+ 'hide-hostname': True,
+ }
+ },
+ {
+ 'name': 'Policy PAP',
+ 'page': 'pap/local-swagger',
+ 'spec': 'https://raw.githubusercontent.com/onap/policy-pap/master/main/src/main/resources/openapi/openapi.yaml',
+ 'opts': {
+ 'lazy-rendering': False,
+ 'suppress-warnings': True,
+ 'hide-hostname': True,
+ }
+ },
+ {
+ 'name': 'Policy XACML',
+ 'page': 'xacml/local-swagger',
+ 'spec': 'https://raw.githubusercontent.com/onap/policy-xacml-pdp/master/main/src/main/resources/openapi/openapi.yaml',
+ 'opts': {
+ 'lazy-rendering': False,
+ 'suppress-warnings': True,
+ 'hide-hostname': True,
+ }
+ },
+ {
+ 'name': 'Policy ACM-R',
+ 'page': 'clamp/acm/api-protocol/local-swagger',
+ 'spec': 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/openapi.yaml',
+ 'opts': {
+ 'lazy-rendering': False,
+ 'suppress-warnings': True,
+ 'hide-hostname': True,
+ }
+ },
]
#
@@ -53,5 +97,6 @@ def setup(app):
app.add_css_file("css/ribbon.css")
linkcheck_ignore = [
- r'http://localhost:\d+/'
+ r'http://localhost:\d+/',
+ r'./local-swagger.html(.*?)'
]