pmproducer/docs/api-docs.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 (C) 2021 Nordix
   4
   5 .. _api_docs:
   6
   7 .. |swagger-icon| image:: ./images/swagger.png
   8                   :width: 40px
   9
  10 .. |yaml-icon| image:: ./images/yaml_logo.png
  11                   :width: 40px
  12
  13
  14 ========
  15 API-Docs
  16 ========
  17
  18 Here we describe the APIs to access the Non-RT PM Producer.
  19
  20 PM Producer
  21 =============
  22
  23 The PM Producer provides support for delivery of PM measurement data over Kafka.
  24
  25 See `PM Producer API <./pm-producer-api.html>`_ for full details of the API.
  26
  27 The API is also described in Swagger-JSON and YAML:
  28
  29
  30 .. csv-table::
  31    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  32    :widths: 10,5, 5
  33
  34    "PM Producer API", ":download:`link <../api/api.json>`", ":download:`link <../api/api.yaml>`"