chore: set API description is valid. 🎉

Author: frckbrice

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx lint-staged
+npx lint-staged 

.husky/pre-push.bak

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npm test
+npm test && npm run validate && npm run format:check

public/api_spec_image_1.png

@@ -19,37 +19,37 @@ npm install @cocoaflow/js-sdk
 ### Proposed Usage Pattern
 
 ```typescript
-import { CocoaFlowAPI } from '@cocoaflow/js-sdk';
+import { CocoaFlowAPI } from "@cocoaflow/js-sdk";
 
 // Initialize the client
 const client = new CocoaFlowAPI({
-  apiKey: 'your-api-key',
-  baseURL: 'https://api.cocoaflow.com'
+  apiKey: "your-api-key",
+  baseURL: "https://api.cocoaflow.com",
 });
 
 // Authenticate
 await client.auth.login({
-  email: 'user@example.com',
-  password: 'password'
+  email: "user@example.com",
+  password: "password",
 });
 
 // Create a farm
 const farm = await client.farms.create({
   location: {
     lat: 6.5244,
-    lng: 3.3792
+    lng: 3.3792,
   },
-  farmer_id: 'clh1234567890abcdef',
-  village: 'Ibadan Village',
-  division: 'Oyo Division',
-  council: 'Ibadan Council'
+  farmer_id: "clh1234567890abcdef",
+  village: "Ibadan Village",
+  division: "Oyo Division",
+  council: "Ibadan Council",
 });
 
 // List farms with pagination
 const farms = await client.farms.list({
   limit: 20,
   offset: 0,
-  company_id: 'clh1234567890abcdef'
+  company_id: "clh1234567890abcdef",
 });
 ```
 
@@ -65,7 +65,7 @@ const farms = await client.farms.list({
 ## API Coverage (Based on Specification)
 
 - ✅ Companies Management
-- ✅ User Management  
+- ✅ User Management
 - ✅ Farmer Profiles
 - ✅ Farm Operations
 - ✅ Project Management
@@ -98,4 +98,4 @@ const farms = await client.farms.list({
 
 ## License
 
-Apache 2.0 
+Apache 2.0

sdks/javascript/README.md

@@ -61,7 +61,7 @@ farm_details = client.farms.get(farm_id='clh1234567890abcdef')
 ## API Coverage
 
 - ✅ Companies Management
-- ✅ User Management  
+- ✅ User Management
 - ✅ Farmer Profiles
 - ✅ Farm Operations
 - ✅ Project Management
@@ -80,7 +80,7 @@ from cocoaflow import AsyncCocoaFlowAPI
 
 async def main():
     client = AsyncCocoaFlowAPI(api_key='your-api-key')
-    
+
     # Create multiple farms
     farms = []
     for i in range(5):
@@ -92,7 +92,7 @@ async def main():
             'council': 'Ibadan Council'
         })
         farms.append(farm)
-    
+
     return farms
 
 # Run async function
@@ -107,4 +107,4 @@ farms = asyncio.run(main())
 
 ## License
 
-Apache 2.0 
+Apache 2.0

sdks/python/README.md

@@ -244,9 +244,9 @@ paths:
   "/farms/{id}":
     $ref: paths/farm/farm_{id}.yaml
   "/audits": # unified audits endpoint
-    $ref: paths/audits.yaml
+    $ref: paths/audit/audits.yaml
   "/audits/{audit_id}": # unified audits endpoint
-    $ref: "paths/audits.yaml"
+    $ref: "paths/audit/audits_{id}.yaml"
   "/receipts": # receipts
     $ref: paths/receipt/receipt.yaml
   "/receipts/{id}":
@@ -263,23 +263,22 @@ paths:
     $ref: paths/market/market_{company_id}.yaml
   "/inspection_data": # inspection_data
     $ref: "paths/inspection_data/inspection_data.yaml"
-  "/inspection_data/{inspection_id}": # inspection_data
-    $ref: "paths/inspection_data/inspection_data_{inspection_id}.yaml"
-
+  "/inspection_data/{project_id}": # inspection_data
+    $ref: "paths/inspection_data/inspection_data_{id}.yaml"
   "/subscriptions": # subcription
     $ref: "paths/subscription/subscription.yaml"
   "/subscriptions/{subscription_id}": # subscription
-    $ref: "paths/subscription/subscription_{subscription_id}.yaml"
+    $ref: "paths/subscription/subscription_{id}.yaml"
   "/subscriptions/{company_id}/company":
     $ref: paths/subscription/subscription_{company_id }_company.yaml
   "/trainings": # training
     $ref: paths/training/training.yaml
   "/trainings/{training_id}": # training
-    $ref: "paths/training/training.yaml"
+    $ref: "paths/training/training_{id}.yaml"
   "/transaction": # transaction
-    $ref: paths/transaction.yaml
+    $ref: paths/transaction/transaction.yaml
   "/transaction/{transaction_id}": # transaction
-    $ref: "paths/transaction.yaml"
+    $ref: "paths/transaction/transaction_{id}.yaml"
   "/campaign_stocks": #campaign_stock
     $ref: paths/campaign_stock/campaign_stock.yaml
   "/campaign_stocks/{campaign_id}":
@@ -295,9 +294,9 @@ paths:
   "/collector_agents/{id}":
     $ref: paths/collector_agent/collector_agent_{id}.yaml
   "/training_session": #participants
-    $ref: paths/training_session.yaml
+    $ref: paths/training_sessions/training_session.yaml
   "/training_session/{session_id}": #participants
-    $ref: paths/training_session.yaml
+    $ref: paths/training_sessions/training_session_{id}.yaml
   "/price_plan_requirements":
     $ref: paths/price_plan_requirement.yaml
 components:
@@ -366,165 +365,27 @@ components:
 
   parameters:
     PaginationLimit:
-      name: limit
-      in: query
-      description: Number of items to return (max 100)
-      required: false
-      schema:
-        type: integer
-        minimum: 1
-        maximum: 100
-        default: 20
-        example: 20
+      $ref: components/parameters/PaginationLimit.yaml
     PaginationOffset:
-      name: offset
-      in: query
-      description: Number of items to skip for pagination
-      required: false
-      schema:
-        type: integer
-        minimum: 0
-        default: 0
-        example: 0
+      $ref: components/parameters/PaginationOffset.yaml
     CompanyId:
-      name: company_id
-      in: query
-      description: Filter by company ID
-      required: false
-      schema:
-        type: string
-        format: cuid
-        example: "clh1234567890abcdef"
+      $ref: components/parameters/CompanyId.yaml
     DateRangeStart:
-      name: start_date
-      in: query
-      description: Start date for filtering (ISO 8601 format)
-      required: false
-      schema:
-        type: string
-        format: date
-        example: "2024-01-01"
+      $ref: components/parameters/DateRangeStart.yaml
     DateRangeEnd:
-      name: end_date
-      in: query
-      description: End date for filtering (ISO 8601 format)
-      required: false
-      schema:
-        type: string
-        format: date
-        example: "2024-12-31"
+      $ref: components/parameters/DateRangeEnd.yaml
 
   responses:
     UnauthorizedError:
-      description: Authentication credentials were missing or invalid
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              error:
-                type: string
-                example: "Unauthorized"
-              message:
-                type: string
-                example: "Invalid or missing authentication token"
-              code:
-                type: string
-                example: "AUTH_REQUIRED"
+      $ref: components/responses/UnauthorizedError.yaml
     ForbiddenError:
-      description: The request was understood but the server is refusing to authorize it
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              error:
-                type: string
-                example: "Forbidden"
-              message:
-                type: string
-                example: "Insufficient permissions to access this resource"
-              code:
-                type: string
-                example: "INSUFFICIENT_PERMISSIONS"
+      $ref: components/responses/ForbiddenError.yaml
     ValidationError:
-      description: The request was well-formed but contains invalid parameters
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              error:
-                type: string
-                example: "Validation Error"
-              message:
-                type: string
-                example: "Request validation failed"
-              details:
-                type: array
-                items:
-                  type: object
-                  properties:
-                    field:
-                      type: string
-                      example: "email"
-                    message:
-                      type: string
-                      example: "Invalid email format"
-              code:
-                type: string
-                example: "VALIDATION_ERROR"
+      $ref: components/responses/ValidationError.yaml
     RateLimitError:
-      description: Too many requests, please try again later
-      headers:
-        X-RateLimit-Limit:
-          description: The number of allowed requests in the current period
-          schema:
-            type: integer
-        X-RateLimit-Remaining:
-          description: The number of remaining requests in the current period
-          schema:
-            type: integer
-        X-RateLimit-Reset:
-          description: The number of seconds left in the current period
-          schema:
-            type: integer
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              error:
-                type: string
-                example: "Rate Limit Exceeded"
-              message:
-                type: string
-                example: "Too many requests, please try again later"
-              retry_after:
-                type: integer
-                example: 3600
-              code:
-                type: string
-                example: "RATE_LIMIT_EXCEEDED"
+      $ref: components/responses/RateLimitError.yaml
     ServerError:
-      description: Internal server error
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              error:
-                type: string
-                example: "Internal Server Error"
-              message:
-                type: string
-                example: "An unexpected error occurred"
-              request_id:
-                type: string
-                example: "req_1234567890abcdef"
-              code:
-                type: string
-                example: "INTERNAL_ERROR"
+      $ref: components/responses/ServerError.yaml
 
 security:
   - BearerAuth: []

swt_api_spec/cocoaflow-api.yaml

@@ -5,4 +5,4 @@ required: false
 schema:
   type: string
   format: cuid
-  example: "clh1234567890abcdef" 
+  example: "clh1234567890abcdef"

swt_api_spec/components/parameters/CompanyId.yaml

@@ -5,4 +5,4 @@ required: false
 schema:
   type: string
   format: date
-  example: "2024-12-31" 
+  example: "2024-12-31"

swt_api_spec/components/parameters/DateRangeEnd.yaml

@@ -5,4 +5,4 @@ required: false
 schema:
   type: string
   format: date
-  example: "2024-01-01" 
+  example: "2024-01-01"

swt_api_spec/components/parameters/DateRangeStart.yaml

@@ -7,4 +7,4 @@ schema:
   minimum: 1
   maximum: 100
   default: 20
-  example: 20 
+  example: 20