Add dcoumentation for API (#18)

2024-05-22 19:43:17 +10:00
parent b9643f41e1
commit e0fc68d4c0
7 changed files with 100 additions and 14 deletions
--- a/apps/docs/api-reference/openapi.json
+++ b/apps/docs/api-reference/openapi.json
@@ -106,6 +106,18 @@
    },
    "/v1/emails/{emailId}": {
      "get": {
+        "parameters": [
+          {
+            "schema": {
+              "type": "string",
+              "minLength": 3,
+              "example": "1212121"
+            },
+            "required": true,
+            "name": "emailId",
+            "in": "path"
+          }
+        ],
        "responses": {
          "200": {
            "description": "Retrieve the user",