Update docs and add api docs

README.md

@@ -13,9 +13,6 @@
             <img src="https://img.shields.io/badge/LICENSE-MIT-orange.svg">
         </a>
     </p>
-    <p align="center">
-        <a href="https://www.producthunt.com/posts/lynx-4?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-lynx&#0045;4" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=446391&theme=neutral" alt="Lynx - A&#0032;Fast&#0044;&#0032;Secure&#0032;and&#0032;Reliable&#0032;Terraform&#0032;Backend&#0046; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
-    </p>
 </p>
 <br/>
 

api.yml

@@ -0,0 +1,62 @@
+openapi: 3.0.1
+info:
+  title: Lynx
+  description: 🐺 A Fast, Secure and Reliable Terraform Backend, Set up in Minutes.
+  contact:
+    email: hello@clivern.com
+  license:
+    name: Apache License 2.0
+    url: https://github.com/Clivern/Lynx/blob/main/LICENSE
+  version: 0.9.0
+externalDocs:
+  description: Find out more about cattle
+  url: https://github.com/Clivern/Lynx
+servers:
+  - url: https://localhost:4000/
+paths:
+  /_health:
+    get:
+      tags:
+        - Liveness
+      summary: Get system health status
+      responses:
+        '200':
+          description: System is healthy
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HealthResponse'
+        '500':
+          description: System is down
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HealthResponse'
+  /_ready:
+    get:
+      tags:
+        - Readiness
+      summary: Get system readiness
+      responses:
+        '200':
+          description: System is ready to accept traffic
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HealthResponse'
+        '500':
+          description: System not ready to accept traffic
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HealthResponse'
+
+components:
+  schemas:
+    HealthResponse:
+      type: object
+      properties:
+        status:
+          type: string
+        errorMessage:
+          type: string