From 55e1f559eb898e470bb7af9f83fb0ac23069bf34 Mon Sep 17 00:00:00 2001 From: Chenfei Gao Date: Tue, 21 May 2019 13:32:30 -0400 Subject: Add policy design api documentation Adding swagger and global api table to api rst documentation Issue-ID: POLICY-1680 Change-Id: Iae966917b73a8762172e708fe207c4fc6e52615f Signed-off-by: Chenfei Gao --- docs/api/api.rst | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) (limited to 'docs/api/api.rst') diff --git a/docs/api/api.rst b/docs/api/api.rst index 7df880ca..fb42e3e7 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -1,14 +1,38 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 .. _api-label: Policy Lifecycle API -------------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 1 +Global API Table +-------------------- +.. csv-table:: + :header: "API name", "Swagger JSON" + :widths: 10,5 + + "Healthcheck API", ":download:`link `" + "Statistics API", ":download:`link `" + "Tosca Policy Type API", ":download:`link `" + "Tosca Policy API", ":download:`link `" + "Legacy Guard Policy API", ":download:`link `" + "Legacy Operational Policy API", ":download:`link `" + +API Swagger +-------------------- + +.. swaggerv2doc:: healthcheck-api.json + +.. swaggerv2doc:: statistics-api.json +.. swaggerv2doc:: policytype-api.json +.. swaggerv2doc:: policy-api.json +.. swaggerv2doc:: guard-policy-api.json -End of Document +.. swaggerv2doc:: operational-policy-api.json -- cgit 1.2.3-korg