chore: update docs & text

aldinokemal · Jul 14, 2024 · 9cb8f75 · 9cb8f75
1 parent 3bb912d
commit 9cb8f75
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 5 deletions.
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: WhatsApp API MultiDevice
-  version: 4.1.0
+  version: 4.2.0
   description: This API is used for sending whatsapp via API
 servers:
   - url: http://localhost:3000
@@ -36,6 +36,32 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorInternalServer'
+  /app/login-with-code:
+    get:
+      operationId: appLoginWithCode
+      tags:
+        - app
+      summary: Login with pairing code
+      parameters:
+        - name: phone
+          in: query
+          schema:
+            type: string
+          example: '628912344551'
+          description: Your phone number
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LoginWithCodeResponse'
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorInternalServer'
   /app/logout:
     get:
       operationId: appLogout
@@ -1241,6 +1267,21 @@ components:
               device:
                 type: string
                 example: '628960561XXX.0:[email protected]'
+    LoginWithCodeResponse:
+      type: object
+      properties:
+        code:
+          type: string
+          example: SUCCESS
+        message:
+          type: string
+          example: Success
+        results:
+          type: object
+          properties:
+            pair_code:
+              type: string
+              example: ABCD-1234
     LoginResponse:
       type: object
       properties:

diff --git a/src/views/components/AppLogin.js b/src/views/components/AppLogin.js
@@ -43,7 +43,7 @@ export default {
         <div class="content">
             <div class="header">Login</div>
             <div class="description">
-                Scan your QRCode and you can use all this API feature
+                Scan your QR code to access all this API capability.
             </div>
         </div>
     </div>

diff --git a/src/views/components/AppLoginWithCode.js b/src/views/components/AppLoginWithCode.js
@@ -69,7 +69,7 @@ export default {
         <div class="content">
             <div class="header">Login with Code</div>
             <div class="description">
-                Login with pairing code to get access to your devices
+                Enter your pairing code to log in and access your devices.
             </div>
         </div>
     </div>

diff --git a/src/views/components/AppReconnect.js b/src/views/components/AppReconnect.js
@@ -28,8 +28,7 @@ export default {
         <div class="content">
             <div class="header">Reconnect</div>
             <div class="description">
-                Reconnect to whatsapp server, please do this if your api doesn't work or your application is down or
-                restart
+                Please reconnect to the WhatsApp service if your API doesn't work or if your app is down.
             </div>
         </div>
     </div>