aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis.rst
blob: 28d6f6dc29ca7de74b77502288d4c3dc4e870b04 (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

.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. _sdcofferedapis:

================
SDC Offered APIs
================

The list of APIs that SDC offers can be found from the following table:

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

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

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

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

   "swagger json file", "html doc", "pdf doc"
   ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`"
ecific language governing permissions and # limitations under the License. # ============LICENSE_END========================================================= ### class NetconfAppConfiguration(object): @staticmethod def get_configuration(args: list): if len(args) >= 4: configuration_file = args[1] kafka_host_name = args[2] kafka_port = args[3] kafka_topic = args[4] return NetconfAppConfiguration(configuration_file, kafka_host_name, int(kafka_port), kafka_topic), None else: return None, "Invalid number of arguments. Please provide all required arguments." def __init__(self, module_configuration_file_path: str, kafka_host_name: str, kafka_port: int, kafka_topic: str): self.module_configuration_file_path = module_configuration_file_path self.kafka_host_name = kafka_host_name self.kafka_port = kafka_port self.kafka_topic = kafka_topic def __str__(self): return "NetconfAppConfiguration[configuration_file -> '{}', " \ "kafka_host_name -> '{}', kafka_port -> '{}', kafka_topic -> '{}']"\ .format(self.module_configuration_file_path, self.kafka_host_name, self.kafka_port, self.kafka_topic)