chore: fix the generated client issue

Author: frckbrice

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "22"
           cache: "npm"
 
       - name: Install dependencies
@@ -64,7 +64,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "22"
           cache: "npm"
 
       - name: Install dependencies
@@ -116,7 +116,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "22"
           cache: "npm"
 
       - name: Install dependencies

README.md

@@ -13,17 +13,16 @@
 
 ## 🌟 Overview
 
-CocoaFlow is a comprehensive **API specification** designed for managing cocoa industry operations, including farmer management, farm tracking, certification compliance, and supply chain optimization. This specification serves as the contract between frontend and backend teams, ensuring consistent development and integration.
-
-> **Note**: This is an API specification project. The actual API implementation is in development. You can use this specification to understand the API design and generate client libraries.
+CocoaFlow is a comprehensive **API specification** designed for managing cocoa industry operations, from farm to end consumer, including farmer management, farm tracking, certification compliance, and supply chain optimization. This specification serves as the contract between frontend and backend teams, ensuring consistent development and integration.
 
 ### 🎯 Key Features
 
 - **Farmer Management**: Complete farmer profiles, contracts, and relationship tracking
 - **Farm Operations**: GPS coordinates, inspection data, and compliance monitoring
+- **Inspections (internal and external)**: follow up of farmer to comply with Rainforest Alliance standards and regulations for agriculture.
 - **Certification Support**: Rainforest Alliance compliance tracking and audit trails
-- **Supply Chain**: Market management, transactions, and inventory tracking
-- **Training & Education**: Session management and participant tracking
+- **Supply Chain**: Market management, transactions, and inventory tracking, and tansport and storage to factory plant.
+- **Training & Education**: Session management and participant tracking for farmers by the industry.
 - **Analytics & Reporting**: Comprehensive data insights and business intelligence
 
 ### 🏗️ Architecture Highlights
@@ -66,9 +65,17 @@ npm run docs:build       # Build static documentation
 npm run lint            # Lint OpenAPI specification
 npm run validate        # Validate specification
 
+or
+npm run test            # Run tests
+
+
 # Build & Generate
 npm run bundle          # Bundle specification into single file
 npm run generate:client # Generate TypeScript client
+
+# view the specification
+npm run build
+npm run preview
 ```
 
 ## 📚 Documentation

openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.14.0"
+  }
+}

package.json

@@ -28,8 +28,8 @@
     "url": "https://github.com/frckbrice/project-api_spec/issues"
   },
   "engines": {
-    "node": ">=18.0.0",
-    "npm": ">=8.0.0"
+    "node": ">=22.0.0",
+    "npm": ">=10.0.0"
   },
   "scripts": {
     "prepare": "husky install",
@@ -46,7 +46,7 @@
     "docs:serve": "redocly preview-docs ./swt_api_spec/cocoaflow-api.yaml --port 8080",
     "docs:build": "redocly build-docs ./swt_api_spec/cocoaflow-api.yaml -o ./public/index.html",
     "generate:client": "openapi-generator-cli generate -i ./dist/cocoaflow-api.yaml -g typescript-axios -o ./generated/typescript",
-    "generate:postman": "openapi-generator-cli generate -i ./dist/cocoaflow-api.yaml -g postman -o ./generated/postman",
+    "generate:postman": "openapi-generator-cli generate -i ./dist/cocoaflow-api.yaml -g postman-collection -o ./generated/postman",
     "clean": "rm -rf ./dist ./generated ./docs",
     "version": "npm run bundle && git add -A dist",
     "postversion": "git push && git push --tags"

swt_api_spec/cocoaflow-api.yaml

@@ -219,8 +219,7 @@ paths:
   "/auth/logout":
     $ref: paths/auth/logout.yaml
   "/auth/me":
-    get:
-      $ref: paths/auth/auth.yaml#/get
+    $ref: paths/auth/me.yaml
   "/users": # user
     $ref: paths/user/user.yaml
   "/users/{id}":

swt_api_spec/paths/auth/auth.yaml

@@ -1,43 +1,3 @@
-get:
-  tags:
-    - 🔐 Authentication
-  summary: Get current user
-  description: Get the currently authenticated user's information
-  operationId: getCurrentUser
-  security:
-    - BearerAuth: []
-  responses:
-    "200":
-      description: User profile retrieved successfully
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              success:
-                type: boolean
-                example: true
-              data:
-                $ref: "../../components/schemas/user.yaml"
-          example:
-            success: true
-            data:
-              id: "clh1234567890abcdef"
-              email: "user@example.com"
-              first_name: "John"
-              last_name: "Doe"
-              role: "user"
-              company_id: "clh1234567890abcdef"
-              phone_number: "+2341234567890"
-              is_active: true
-              last_login: "2024-01-15T10:30:00Z"
-              created_at: "2024-01-15T10:30:00Z"
-              updated_at: "2024-01-15T10:30:00Z"
-    "401":
-      $ref: "../../components/responses/UnauthorizedError.yaml"
-    "500":
-      $ref: "../../components/responses/ServerError.yaml"
-
 post:
   tags:
     - 🔐 Authentication

swt_api_spec/paths/auth/me.yaml

@@ -0,0 +1,39 @@
+get:
+  tags:
+    - 🔐 Authentication
+  summary: Get current user
+  description: Get the currently authenticated user's information
+  operationId: getCurrentUser
+  security:
+    - BearerAuth: []
+  responses:
+    "200":
+      description: User profile retrieved successfully
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              success:
+                type: boolean
+                example: true
+              data:
+                $ref: "../../components/schemas/user.yaml"
+          example:
+            success: true
+            data:
+              id: "clh1234567890abcdef"
+              email: "user@example.com"
+              first_name: "John"
+              last_name: "Doe"
+              role: "user"
+              company_id: "clh1234567890abcdef"
+              phone_number: "+2341234567890"
+              is_active: true
+              last_login: "2024-01-15T10:30:00Z"
+              created_at: "2024-01-15T10:30:00Z"
+              updated_at: "2024-01-15T10:30:00Z"
+    "401":
+      $ref: "../../components/responses/UnauthorizedError.yaml"
+    "500":
+      $ref: "../../components/responses/ServerError.yaml"