Add policy design api documentation
[policy/parent.git] / docs / api / api.rst
1 .. This work is licensed under a
2 .. Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4
5 .. _api-label:
6
7 Policy Lifecycle API
8 --------------------
9 .. toctree::
10    :maxdepth: 1 
11
12 Global API Table
13 --------------------
14 .. csv-table::
15    :header: "API name", "Swagger JSON"
16    :widths: 10,5
17
18    "Healthcheck API", ":download:`link <healthcheck-api.json>`"
19    "Statistics API", ":download:`link <statistics-api.json>`"
20    "Tosca Policy Type API", ":download:`link <policytype-api.json>`"
21    "Tosca Policy API", ":download:`link <policy-api.json>`"
22    "Legacy Guard Policy API", ":download:`link <guard-policy-api.json>`"
23    "Legacy Operational Policy API", ":download:`link <operational-policy-api.json>`"
24
25 API Swagger
26 --------------------
27
28 .. swaggerv2doc:: healthcheck-api.json
29
30 .. swaggerv2doc:: statistics-api.json
31
32 .. swaggerv2doc:: policytype-api.json
33
34 .. swaggerv2doc:: policy-api.json
35
36 .. swaggerv2doc:: guard-policy-api.json
37
38 .. swaggerv2doc:: operational-policy-api.json