summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordfarrelly <david.farrelly@est.tech>2020-01-16 15:14:48 +0000
committerdfarrelly <david.farrelly@est.tech>2020-01-16 15:17:00 +0000
commitd0236cf6f7f77601a3f9e52a44d88579b5c4344b (patch)
tree38f16983c35d2642093b3a25ddb9dde2f842ed52
parent3bdcd5fcf45254a27cee6e244eddcc63cabb43e8 (diff)
Add PMSH API docs
Issue-ID: DCAEGEN2-1916 Change-Id: I286c432f0e1d621b2d32211ed08a62d3f0082fc1 Signed-off-by: dfarrelly <david.farrelly@est.tech>
-rw-r--r--docs/sections/apis/PMSH.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/sections/apis/PMSH.rst b/docs/sections/apis/PMSH.rst
new file mode 100644
index 00000000..17fd6d26
--- /dev/null
+++ b/docs/sections/apis/PMSH.rst
@@ -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 |
++-----------+---------------------+