diff options
| -rw-r--r-- | docs/sections/apis/PMSH.rst | 52 |
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 | ++-----------+---------------------+ |