updated api contract for discord invite

Author: vinayak-trivedi

discord-actions/README.md

@@ -2,10 +2,11 @@
 
 ## **Requests**
 
-|            Route             |        Description        |
-| :--------------------------: | :-----------------------: |
-| [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 |
+|                          Route                          |           Description            |
+| :-----------------------------------------------------: | :------------------------------: |
+|  [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-actions/invite**
@@ -28,11 +29,12 @@
     ```json
     {
       "message": "Invite return successfully!",
-      "inviteLink":  "discord_invite_link_here"
+      "inviteLink": "discord_invite_link_here"
     }
     ```
 
 - **Error Responses:**
+
   - **Code:** 401
     - **Content:**
     ```json
@@ -58,6 +60,7 @@
         "message": "Invite not found for user!"
       }
       ```
+
   - **Code:** 500
     - **Content:**
     ```json
@@ -70,51 +73,69 @@
 
 ## **POST /discord/invites**
 
-- This Api is used to create a discord invite for the user, invite for a particular user can be generated by a super user or a that user only, invite for a particular user can be created only once
+- This Api is used to create a discord invite for the user, invite for a particular user can be generated by a super user or a that user only, invite for a particular user can be created only once, Following conditions will be there for creating invite for the user:
+- The user should not be archieved
+- The user should have one of these roles, if they want to directly generate a invite: product_manager, designer, maven
+- If they don't have the roles mentioned above, they should have profileStatus approved
 
 - **Params**\
-    None
+   None
 - **Query**\
-    - 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
+  - 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**\
-    None
+   None
 - **Headers**\
-    None
+   None
 - **Cookie**\
-    None
+   None
 - **Success Response:**
-    - **Code:** 201
-        - **Content:** 
-        ```json
-       {
-         "message": "Invite created successfully.",
-         "inviteLink": "string",
-       }
-      ```
+
+  - **Code:** 201
+    - **Content:**
+    ```json
+    {
+      "message": "Invite created successfully.",
+      "inviteLink": "string"
+    }
+    ```
   - **Code:** 401
     - **Content:**
       ```json
-        { 
-          "statusCode": 401,
-          "error": "Unauthorized", 
-          "message": "Unauthenticated user" 
-        }
+      {
+        "statusCode": 401,
+        "error": "Unauthorized",
+        "message": "Unauthenticated user"
+      }
       ```
   - **Code:** 409
+
     - **Content:**
       ```json
-        { 
-          "message": "User invite is already present!"
+      {
+        "message": "User invite is already present!"
+      }
+      ```
+
+  - **Code:** 403
+    - **Content:**
+      ```json
+        {
+          "statusCode": 403,
+          "error": "Forbidden",
+          "message": "User should be super user to generate link for other users" "||" "Only users who have never joined discord can generate invite link" "||" "Archived users cannot generate invite" "||" "Only selected roles can generate discord link directly"
         }
       ```
 
 - **Error Response:**
-    - **Code:** 500
-        - **Content:**
-          ```json
-           { 
-             "statusCode": 500,
-             "error": "Internal Server Error", 
-             "message": "An internal server error occurred" 
-           }
+  - **Code:** 500
+    - **Content:**
+      ```json
+      {
+        "statusCode": 500,
+        "error": "Internal Server Error",
+        "message": "An internal server error occurred"
+      }
       ```
+    ```
+
+    ```