docs for APIs updated to resonate with fusionauth docs (#72)

* docs for APIs updated

* docs for other apis improved

* schema added in dto of req body

* flow diagrams added for remaining apis

docs/api/OTP.md

@@ -2,14 +2,35 @@
 
 The OTP (One-Time Password) Service is part of a NestJS application that handles the generation, sending, and validation of one-time passwords. It supports multiple delivery methods including email, SMS, and WhatsApp.
 
-## Endpoints
+## Sequence Diagram
 
-### 1. SendOtp
-- **Endpoint** : Post `/otp/send`
+![Groups Sequence Diagram](../assets/sequence-diagrams/otp.jpeg)
+
+## Send OTP 
+### Request
+#### Generates and sends an OTP via specified channels.
+`POST /otp/send`
 - **Description** : Generates and sends an OTP via specified channels.
 - **Parameters:**
     - `type`: string[] - An array of delivery methods ('mail', 'sms', 'whatsapp')
     - `to`: string - The recipient's address (email, phone number, etc.)
+#### Request Parameters
+- `type`: string[] - An array of delivery methods ('mail', 'sms', 'whatsapp')
+- `to`: string - The recipient's address (email, phone number, etc.)
+
+### Response
+
+#### Response Codes
+
+| Code | Description |
+|------|-------------|
+| 200  | The request was successful. The response will contain a JSON body. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
+| 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
+| 404  | The object you are trying to update doesn't exist. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
+
+
 - **Sample cURL**:
   ```sh
   curl -X POST http://localhost:3000/otp/send \
@@ -25,11 +46,27 @@ The OTP (One-Time Password) Service is part of a NestJS application that handles
   type:='["mail", "sms"]' \
   to="[email protected]"
 
-### 2. ValidateOtp
-- **Endpoint** : Post `/otp/verify`
-- **Description** : Validates a given OTP.
-- **Parameters:**
+## Validate OTP
+### Request 
+#### Validates a given OTP.
+`POST /otp/verify`
+
+#### Request Parameters
 -   `otp`: string - The OTP to validate
+
+### Response
+
+#### Response Codes
+
+| Code | Description |
+|------|-------------|
+| 200  | The request was successful. The response will contain a JSON body. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
+| 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
+| 404  | The object you are trying to update doesn't exist. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
+  
+
 - **Sample cURL**:
   ```sh
   curl -X POST http://localhost:3000/otp/verify \

docs/api/applications.md

@@ -27,7 +27,7 @@ The ApplicationService is a crucial component of our NestJS application, respons
 - authorization : `string` *Required*
 
 ### Request Body
-- applicationData : `data (CreateApplicationDTO)`
+- applicationData : `{"active" : boolean, "name" : string, "scopes" : string[], "roles" : string[], "oauthConfiguration" : OauthConfiguration }`
 
 ### Response 
 
@@ -36,9 +36,9 @@ The ApplicationService is a crucial component of our NestJS application, respons
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. 
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -76,7 +76,7 @@ The ApplicationService is a crucial component of our NestJS application, respons
 - authorization : `string` *Required*
 
 ### Request Body
-- applicationData : `data (UpdateApplicationDto)`
+- applicationData : `{"active" ?: boolean, "name" ?: string,  "oauthConfiguration" ?: OauthConfiguration, "jwtConfiguration" : JwtConfiguration }`
 
 ### Response
 
@@ -85,10 +85,10 @@ The ApplicationService is a crucial component of our NestJS application, respons
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -134,10 +134,10 @@ The ApplicationService is a crucial component of our NestJS application, respons
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -175,10 +175,10 @@ The ApplicationService is a crucial component of our NestJS application, respons
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -217,10 +217,10 @@ The ApplicationService is a crucial component of our NestJS application, respons
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -257,7 +257,7 @@ The ApplicationScopesService is a crucial component of our NestJS application, r
 `POST /application/:applicationId/scope/:scopeId`
 
 #### Request Parameters 
-- `data: ScopeDto` - Scope data
+- data : `{"defaultConsentDetail": string, "defaultConsentMessage": string, "name" : string, "required" : boolean}`
 - `applicationsId: string` - Application ID
 - `scopeId: string` - Optional scope ID 
 
@@ -273,10 +273,10 @@ The ApplicationScopesService is a crucial component of our NestJS application, r
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
     
 - **Sample cURL**:
   ```sh
@@ -315,7 +315,7 @@ The ApplicationScopesService is a crucial component of our NestJS application, r
 - authorization : `string`
 
 #### Request Body 
-- `data: UpdateScopeDto` - Scope data
+- data : `{"defaultConsentDetail"?: string, "defaultConsentMessage" ?: string, "name" ?: string, "required" ?: boolean}`
 
 ### Response
 
@@ -324,10 +324,10 @@ The ApplicationScopesService is a crucial component of our NestJS application, r
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -372,10 +372,10 @@ The ApplicationScopesService is a crucial component of our NestJS application, r
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 - **Sample cURL**:
   ```sh
@@ -421,7 +421,7 @@ The ApplicationRolesService is a crucial component of our NestJS application, re
 - authorization : `string`
 
 #### Request Body
-- `data: RoleDto` - Role data
+- data : `{"description" : string, "isDefault" : boolean, "isSuperRole" : boolean, "name" : string}`
 
 ### Response
 
@@ -430,10 +430,10 @@ The ApplicationRolesService is a crucial component of our NestJS application, re
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 
 - **Sample cURL**:
@@ -481,10 +481,10 @@ The ApplicationRolesService is a crucial component of our NestJS application, re
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 
 - **Sample cURL**:
@@ -529,10 +529,10 @@ The ApplicationRolesService is a crucial component of our NestJS application, re
 | Code | Description |
 |------|-------------|
 | 200  | The request was successful. The response will contain a JSON body. |
-| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
+| 400  | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid Auth Service license is required and is not present. |
 | 401  | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty
 | 404  | The object you are trying to update doesn't exist. The response will be empty. |
-| 500  | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
+| 500  | There was an internal error. A stack trace is provided and logged in the Auth Service log files. The response will be empty. |
 
 
 - **Sample cURL**: