Add PMSH API docs 75/100375/1
authordfarrelly <david.farrelly@est.tech>
Thu, 16 Jan 2020 15:14:48 +0000 (15:14 +0000)
committerdfarrelly <david.farrelly@est.tech>
Thu, 16 Jan 2020 15:17:00 +0000 (15:17 +0000)
Issue-ID: DCAEGEN2-1916
Change-Id: I286c432f0e1d621b2d32211ed08a62d3f0082fc1
Signed-off-by: dfarrelly <david.farrelly@est.tech>
docs/sections/apis/PMSH.rst [new file with mode: 0644]

diff --git a/docs/sections/apis/PMSH.rst b/docs/sections/apis/PMSH.rst
new file mode 100644 (file)
index 0000000..17fd6d2
--- /dev/null
@@ -0,0 +1,52 @@
+.. This work is licensed under a
+   Creative Commons Attribution 4.0 International License.
+
+========================
+PM Subscription Handler
+========================
+
+.. contents::
+    :depth: 3
+
+Overview
+========
+
+Component description can be found under `PM Subscription Handler`_.
+
+.. _PM Subscription Handler: ../../sections/services/pm-subscription-handler/index.html
+
+Paths
+=====
+
+GET ``/healthcheck``
+--------------------
+
+Description
+~~~~~~~~~~~
+This is the health check endpoint. If this returns a 200, the server is alive.
+If anything other than a 200, the server is either dead or no connection to PMSH.
+
+Responses
+~~~~~~~~~
+
++-----------+---------------------+
+| HTTP Code | Description         |
++===========+=====================+
+| **200**   | successful response |
++-----------+---------------------+
+
+GET ``/subscriptions``
+----------------------
+
+Description
+~~~~~~~~~~~
+The subscriptions endpoint can be used to fetch all subscriptions which exist in the database.
+
+Responses
+~~~~~~~~~
+
++-----------+---------------------+
+| HTTP Code | Description         |
++===========+=====================+
+| **200**   | successful response |
++-----------+---------------------+