discord invite API contract

Author: vinayak-trivedi

discord/README.md renamed to discord-actions/README.md

@@ -5,29 +5,27 @@
 
 ```json
 {
+  "id": "string",
+  "inviteLink": "string",
   "userId": "string",
-  "invite": "string",
-  "timestamp": "<unix-timestamp>"
 }
 ```
 
 ## **Requests**
 
 |            Route             |        Description        |
 | :--------------------------: | :-----------------------: |
-| [GET /discord/invites](#get-discord-invites) | return all the invites generated |
-[POST /discord/invites](#post-discord-invites) | generates a invite for a user |
+| [GET /discord/invites](#get-discord-actions-invites) | return all the invites generated |
+[POST /discord/invites](#post-discord-actions -invites) | generates a invite for a user |
 ---
 
-## **GET /discord/invites**
+## **GET /discord-actions/invite**
 
-- This API can only be accessed by super user and if the query param contains userId and the userId matches the userId of the user then it return the invite generated by that user
-
-returns all the invites if there is no query param sent in the url, if there is a query param userId it return invite generated for a particulat user
+- return the discord invite created for the user
 
 - **Query**
 
-  - Optional: `userId=[string]`: if this is provided it returns the invite for a pariticular user if the userId of the user matches the userId in query param, or the user is super user, other it return 403
+  - Optional: `userId=[string]`: if this is provided it returns the invite of the user whose userId is provided in the query param, if the user is not a super user then this should be equal to the userId of the user, if no userId is provided, it return invite for the user who has made the request
 
 - **Headers**  
   None
@@ -40,8 +38,8 @@ returns all the invites if there is no query param sent in the url, if there is
     - **Content:**
     ```json
     {
-      "message": "invite returned successfully" || "invites returned successfully",
-      "invite": ["<invite object>, <invite object>"] || "<invite object>" 
+      "message": "Invite return successfully!",
+      "inviteResponse":  "<invite_object>"
     }
     ```
 
@@ -68,7 +66,7 @@ returns all the invites if there is no query param sent in the url, if there is
     - **Content:**
       ```json
       {
-        "message": "User not found."
+        "message": "Invite not found for user!"
       }
       ```
   - **Code:** 500
@@ -88,9 +86,9 @@ returns all the invites if there is no query param sent in the url, if there is
 - **Params**\
     None
 - **Query**\
-    None
+    - Optional: `userId=[string]`: if this is provided it create the invite for that userId if the user is a super user, if this is not provided it create invite for the user making the request
 - **Body**\
-    `{ userId: <string> }`
+    None
 - **Headers**\
     None
 - **Cookie**\
@@ -100,7 +98,8 @@ returns all the invites if there is no query param sent in the url, if there is
         - **Content:** 
         ```json
        {
-         "message": "Invite created successfully."
+         "message": "Invite created successfully.",
+         "inviteLink": "string",
        }
       ```
   - **Code:** 401
@@ -112,18 +111,11 @@ returns all the invites if there is no query param sent in the url, if there is
           "message": "Unauthenticated user" 
         }
       ```
-  - **Code:** 404
-    - **Content:**
-      ```json
-        { 
-          "message": "user doesn't exist"
-        }
-      ```
   - **Code:** 409
     - **Content:**
       ```json
         { 
-          "message": "invite already exists"
+          "message": "User invite is already present!"
         }
       ```