docs/api/offered_consumed_apis.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; back.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 Huawei Technologies Co., Ltd.

SO Offered and Consumed APIs
============================

The list of APIs that SO offers can be found in following table:

.. |yml-icon| image:: swagger/images/yaml.png
              :width: 40px

.. |swagger-icon| image:: swagger/images/swagger.png
                   :width: 40px

.. |html-icon| image:: swagger/images/html.png
               :width: 40px

.. csv-table::
   :header: "|Swagger-icon|", "|html-icon|", "|yml-icon|"
   :widths: 60,60,60

   "swagger json file", "html doc", "yaml doc"
   ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.yaml>`"

The list of APIs that SO offerers for monitoring the BPMN flows
could be found in the following table:

.. csv-table::
   :header: "|Swagger-icon|", "|yml-icon|"
   :widths: 60,60

   "swagger json file", "yaml doc"
   ":download:`link <swagger/SO_MONITORING_SWAGGER.json>`", ":download:`link <swagger/SO_MONITORING_SWAGGER.yaml>`"

Further Reading
---------------

Detailed documentation can be found here:

.. toctree::
   :maxdepth: 1

   apis/serviceInstances-api.rst
   apis/e2eServiceInstances-api.rst
   apis/consumed-apis.rst