summaryrefslogtreecommitdiffstats
path: root/docs/api/offered_consumed_apis.rst
blob: fa872dbeb476a1c155102b8c6218aaf8b026a4b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.. 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.
.. _offeredapis:

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/onap3gppServiceInstances-api.rst
   apis/consumed-apis.rst
   apis/ManagedObject3gppServiceInstances.rst