Merge pull request #80 from cpbinovo/healthcheck

add health check path
BoostV · Oct 9, 2023 · 7186f0e · 7186f0e
2 parents aa2ee22 + a0b4e77
commit 7186f0e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/optimizerapi/health.py b/optimizerapi/health.py
@@ -0,0 +1,2 @@
+def check() -> str:
+    return "OK"
diff --git a/optimizerapi/openapi/specification.yml b/optimizerapi/openapi/specification.yml
@@ -122,6 +122,13 @@ paths:
                           ],
                       },
                   }
+  /health:
+    get:
+      description: Health check endpoint
+      operationId: optimizerapi.health.check
+      responses:
+        "200":
+          description: Service is reachable
 
 components:
   securitySchemes: