0caef0a4262033d596aae9a78f5a1c9ac66ddc2c
[so.git] / docs / api / offered_consumed_apis.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Technologies Co., Ltd.
4
5 SO Offered and Consumed APIs
6 =====================================
7
8 The list of APIs that SO offers can be found in following table:
9
10 .. |yml-icon| image:: swagger/images/yaml.png
11               :width: 40px
12
13 .. |swagger-icon| image:: swagger/images/swagger.png
14                    :width: 40px
15
16 .. |html-icon| image:: swagger/images/html.png
17                :width: 40px
18
19 .. csv-table::
20    :header: "|Swagger-icon|", "|html-icon|", "|yml-icon|"
21    :widths: 60,60,60
22
23    "swagger json file", "html doc", "yaml doc"
24    ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.yaml>`"
25    
26 The list of APIs that SO offerers for monitroing the BPMN flows could be found in the following table:   
27
28 .. csv-table::
29    :header: "|Swagger-icon|", "|yml-icon|"
30    :widths: 60,60
31
32    "swagger json file", "yaml doc"
33    ":download:`link <swagger/SO_MONITORING_SWAGGER.json>`", ":download:`link <swagger/SO_MONITORING_SWAGGER.yaml>`"
34
35 Further Reading
36 ----------------------------------------
37
38 Detailed documentation can be found here:
39
40 .. toctree::
41    :maxdepth: 1
42
43    apis/SO_Interface.rst