Merge pull request #312 from webreinvent/feature/updated-vaahstore-docs

Feature->Develop | Updated: VaahStore Docs

Author: we-vikram-wri231

content/8.vaahstore/1.index.md

@@ -2,8 +2,19 @@
 toc: true
 title: VaahStore
 ---
+<p align="center">
+<img src="/images/vaahcms-two/banner/banner.png">
+</p>
+## Quick Start
 
+Install VaahStore using the CLI:
 
+```bash
+npx vaah store:install
+```
+This command sets up the project with all required configurations, database migrations, and sample data.
+
+---
 ## Introduction
 
 VaahStore is an E-commerce module for `VaahCMS` build on top of latest opensource technologies such as [Laravel](https://laravel.com/docs/10.x), [PrimeVue](https://primevue.org/) and [Vue.js](https://vuejs.org/guide/introduction.html).

content/8.vaahstore/3.basics/1.getting-started.md

@@ -10,13 +10,22 @@ Support
 - VaahStore is made on top of latest opensource technologies `Laravel` ,`Vue.js`, `PrimeVue` and `VaahCMS`.
 ::
 
+## Quick Start
 
+Install VaahStore using the [VaahCLI](https://vaah.dev/cli):
+
+```bash
+npx vaah store:install
+```
+This command sets up the project with all required configurations, database migrations, and sample data.
+
+---
 
 ## How to run the VaahStore
 
-### Step 1. Install VaahStore
+### Step 1. Activate VaahStore Module
 
-To install Vaahstore go into `VaahCMS > Extends > Modules` click on `install` button on top right corner.
+To Activate Vaahstore go into `VaahCMS > Extends > Modules` click on `install` button on top right corner.
 
 Then a `Install Modules` sidebar will open, inside that search `Store` and click on `Install` button.
 

public/vaahstore-api/authentication/refreshToken.yaml

@@ -0,0 +1,81 @@
+post:
+  summary: Refresh API Token
+  description: >
+    Refreshes the user's API token.
+    - If the provided token is still valid, the same token is returned.
+    - If expired, a new token is generated and returned.
+    - Requires a valid Bearer token in the `Authorization` header.
+  operationId: refreshToken
+  security:
+    - bearerAuth: [ ]
+  tags:
+    - Authentication
+  requestBody:
+    required: false
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            remember_me:
+              type: boolean
+              description: >
+                Whether to extend the token validity for 7 days.
+                Default is 2 days if not provided or false.
+              example: true
+  responses:
+    "200":
+      description: Token refreshed successfully or still valid
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: true
+              messages:
+                type: array
+                items:
+                  type: string
+                example: [ "Token refreshed successfully." ]
+              data:
+                type: object
+                properties:
+                  api_token:
+                    type: string
+                    example: "1|XyZAbc123NewTokenValue"
+                  expires_at:
+                    type: string
+                    format: date-time
+                    example: "2025-09-03 15:30:00"
+    "401":
+      description: Invalid or expired token or session exceed from the limit
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              errors:
+                type: array
+                items:
+                  type: string
+                example: [ "Your session has expired because you logged in on another device." ]
+    "400":
+      description: No token provided
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: false
+              errors:
+                type: array
+                items:
+                  type: string
+                example: [ "No token provided." ]

public/vaahstore-api/brands/update.yaml

@@ -1,8 +1,12 @@
 get:
   tags:
     - Brands
-  summary: Get record by brand ID
-  description: Retrieve a brand by its unique identifier.
+  summary: Get record by brand identifies
+  description: |
+    Retrieve a brand by its unique identifier (**id** or **slug**).
+
+    - Use **slug** when fetching the brand for SEO purposes (typically for web pages).
+    - Use **id** in all other cases where a direct reference to the brand is sufficient.
   operationId: getBrandById
   parameters:
     - '$ref': '../vaahstore.yaml#/components/parameters/id'