1 files changed, 34 insertions, 0 deletions
diff --git a/components/pm-subscription-handler/pmsh_service/mod/pmsh_swagger.yml b/components/pm-subscription-handler/pmsh_service/mod/pmsh_swagger.yml
new file mode 100644
index 00000000..7bfecd81
--- /dev/null
+++ b/components/pm-subscription-handler/pmsh_service/mod/pmsh_swagger.yml
@@ -0,0 +1,34 @@
+swagger: "2.0"
+info:
+  title: PM Subscription Handler Service
+  version: "1.0.0"
+  description: This is the swagger file that outlines the PM subscription handler api
+consumes:
+  - "application/json"
+produces:
+  - "application/json"
+
+schemes:
+  - https
+
+# Paths supported by the server application
+paths:
+  /healthcheck:
+    get:
+      operationId: "mod.healthcheck.status"
+      tags:
+        - "HealthCheck"
+      description: >-
+        This is the health check endpoint. If this returns a 200, the server is alive.
+      responses:
+        200:
+          description: Successful response
+          schema:
+            type: object
+            properties:
+              status:
+                type: string
+                description: Overall health of PMSH
+                enum: [healthy, unhealthy]
+        503:
+          description: the pmsh service is unavailable