diff options
| author |   Chenfei Gao <cgao@research.att.com> | 2019-05-21 13:32:30 -0400 |
|---|---|---|
| committer | Chenfei Gao <cgao@research.att.com> | 2019-05-21 13:32:40 -0400 |
| commit | 55e1f559eb898e470bb7af9f83fb0ac23069bf34 (patch) | |
| tree | ef3b2d819e567a66dd24401d8d17024f4663a13e /docs/api/api.rst | |
| parent | 5fc2fdb0eebfec733acbc26dc9ab933279ea2c83 (diff) | |
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 <cgao@research.att.com>
Diffstat (limited to 'docs/api/api.rst')
| -rw-r--r-- | docs/api/api.rst | 30 |
1 files changed, 27 insertions, 3 deletions
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 <healthcheck-api.json>`" + "Statistics API", ":download:`link <statistics-api.json>`" + "Tosca Policy Type API", ":download:`link <policytype-api.json>`" + "Tosca Policy API", ":download:`link <policy-api.json>`" + "Legacy Guard Policy API", ":download:`link <guard-policy-api.json>`" + "Legacy Operational Policy API", ":download:`link <operational-policy-api.json>`" + +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 |