Documentation of PM Producer

[nonrtric/plt/ranpm.git] / pmproducer / docs / api-docs.rst

diff --git a/pmproducer/docs/api-docs.rst b/pmproducer/docs/api-docs.rst
new file mode 100644 (file)
index 0000000..5157446
--- /dev/null
+++ b/pmproducer/docs/api-docs.rst
@@ -0,0 +1,34 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 Nordix
+
+.. _api_docs:
+
+.. |swagger-icon| image:: ./images/swagger.png
+                  :width: 40px
+
+.. |yaml-icon| image:: ./images/yaml_logo.png
+                  :width: 40px
+
+
+========
+API-Docs
+========
+
+Here we describe the APIs to access the Non-RT PM Producer.
+
+PM Producer
+=============
+
+The PM Producer provides support for delivery of PM measurement data over Kafka.
+
+See `PM Producer API <./pm-producer-api.html>`_ for full details of the API.
+
+The API is also described in Swagger-JSON and YAML:
+
+
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5, 5
+
+   "PM Producer API", ":download:`link <../api/api.json>`", ":download:`link <../api/api.yaml>`"