fix: Update campaign status values and requirement schema

Author: frckbrice

.husky/pre-push renamed to .husky/pre-push.bak

@@ -137,160 +137,42 @@ externalDocs:
   url: "https://github.com/frckbrice/project-api_spec"
 
 tags:
-  - name: 🔐 Authentication
-    description: |
-      **User authentication and authorization endpoints**
-
-      Secure JWT Bearer token authentication with OAuth 2.0 support for third-party integrations.
-
-      **Features:**
-      - JWT Token Management
-      - OAuth 2.0 Authorization
-      - Role-based Access Control
-      - Session Management
-  - name: 🏢 Companies
-    description: |
-      **Company management operations for cocoa industry organizations**
-
-      Complete company profile management with multi-tenant support and organizational hierarchy.
-
-      **Features:**
-      - Company Registration & Onboarding
-      - Multi-tenant Architecture
-      - Organizational Hierarchy
-      - Compliance Management
-  - name: 👥 Users
-    description: |
-      **User management for system administrators and company employees**
-
-      Comprehensive user management with role-based permissions and activity tracking.
-
-      **Features:**
-      - User Registration & Profiles
-      - Role-based Permissions
-      - Activity Tracking
-      - Password Management
-  - name: 👨‍🌾 Farmers
-    description: |
-      **Farmer profile and relationship management**
-
-      Digital farmer onboarding with comprehensive profile management and relationship tracking.
-
-      **Features:**
-      - Digital Onboarding
-      - Profile Management
-      - Contract Management
-      - Performance Tracking
-  - name: 🏡 Farms
-    description: |
-      **Farm registration, GPS tracking, and compliance monitoring**
-
-      GPS-enabled farm management with real-time tracking and compliance monitoring.
-
-      **Features:**
-      - GPS Coordinates
-      - Real-time Tracking
-      - Compliance Monitoring
-      - Inspection Data
-  - name: 🌿 Projects
-    description: |
-      **Rainforest Alliance certification projects and compliance tracking**
-
-      Automated compliance tracking with audit trails and certification management.
-
-      **Features:**
-      - Certification Tracking
-      - Audit Trails
-      - Compliance Automation
-      - Reporting Tools
-  - name: 📈 Campaigns
-    description: |
-      **Seasonal campaign management and data collection periods**
-
-      Seasonal campaign management with performance analytics and data collection.
-
-      **Features:**
-      - Campaign Planning
-      - Data Collection
-      - Performance Analytics
-      - Seasonal Management
-  - name: 🏪 Markets
-    description: |
-      **Market sessions for cocoa trading between companies and farmers**
-
-      Digital marketplace for cocoa trading with transaction management and pricing.
-
-      **Features:**
-      - Digital Marketplace
-      - Transaction Management
-      - Pricing Models
-      - Market Analytics
-  - name: 💰 Transactions
-    description: |
-      **Financial transactions and payment processing**
-
-      Secure payment processing with transaction history and financial reporting.
-
-      **Features:**
-      - Payment Processing
-      - Transaction History
-      - Financial Reporting
-      - Audit Trails
-  - name: 🎓 Training
-    description: |
-      **Farmer training sessions and educational content management**
-
-      Comprehensive training management with learning analytics and certification tracking.
-
-      **Features:**
-      - Session Management
-      - Learning Analytics
-      - Certification Tracking
-      - Content Management
-  - name: 🔍 Inspection
-    description: |
-      **Farm inspection data collection and compliance verification**
-
-      Digital inspection tools with automated compliance verification and reporting.
-
-      **Features:**
-      - Digital Inspections
-      - Compliance Verification
-      - Automated Reporting
-      - Data Collection
-  - name: 📊 Analytics
-    description: |
-      **Data analytics and reporting endpoints**
-
-      Comprehensive business intelligence with real-time analytics and custom reporting.
-
-      **Features:**
-      - Business Intelligence
-      - Real-time Analytics
-      - Custom Reporting
-      - Data Visualization
-  - name: ⚙️ Administration
-    description: |
-      **System administration and configuration**
-
-      System-wide administration tools with configuration management and monitoring.
-
-      **Features:**
-      - System Configuration
-      - User Management
-      - Monitoring & Alerts
-      - Backup & Recovery
-  - name: 🌿 Audits
-    description: |
-      **Audit and compliance verification endpoints**
-
-      Comprehensive audit management with compliance verification and reporting.
-
-      **Features:**
-      - Project Audits
-      - Market Audits
-      - Compliance Verification
-      - Audit Reporting
+  - name: "🔐 Authentication"
+    description: "Authentication and authorization endpoints"
+  - name: "🏡 Farms"
+    description: "Farm management operations"
+  - name: "📈 Campaigns"
+    description: "Campaign and stock management"
+  - name: "🏢 Companies"
+    description: "Company management and subscriptions"
+  - name: "💰 Transactions"
+    description: "Transaction processing and management"
+  - name: "💰 Receipts"
+    description: "Receipt generation and management"
+  - name: "🔍 Inspection"
+    description: "Inspection data management"
+  - name: "🎓 Training"
+    description: "Training sessions and management"
+  - name: "User"
+    description: "User account management"
+  - name: "Price"
+    description: "Pricing and subscription plans"
+  - name: "Farm_coodinates"
+    description: "Farm location and mapping data"
+  - name: "Subscription"
+    description: "Subscription management"
+  - name: "Company"
+    description: "Company profile management"
+  - name: "Receipt"
+    description: "Receipt operations"
+  - name: "Inspection_data"
+    description: "Detailed inspection records"
+  - name: "🌿 Projects"
+    description: "Project management and certification tracking"
+  - name: "🏪 Markets"
+    description: "Market session management and trading"
+  - name: "🌿 Audits"
+    description: "Project and market audit management"
 
 x-tagGroups:
   - name: 🏢 Core Operations

swt_api_spec/cocoaflow-api.yaml

@@ -1,36 +1,48 @@
 type: object
+required:
+  - name
+  - start_date
+  - end_date
+  - status
 properties:
   id:
     type: string
     format: cuid
     readOnly: true
-    description: "The unique Id of the campaign."
+    description: "The unique ID of the campaign"
+    example: "clh1234567890abcdef"
   name:
     type: string
-    description: "title of the campaign"
-    readOnly: true
+    description: "The name of the campaign"
+    example: "Spring 2024 Harvest"
   description:
     type: string
-    description: "description of the campaign"
+    description: "Detailed description of the campaign"
+    example: "Main cocoa harvest campaign for Spring 2024"
   start_date:
     type: string
     format: date
-    description: "start date of the campaign"
+    description: "When the campaign starts"
+    example: "2024-09-01"
   end_date:
     type: string
     format: date
-    description: "end date of the campaign"
+    description: "When the campaign ends"
+    example: "2025-03-31"
   status:
     type: string
     enum: ["OPEN", "CLOSED"]
-    description: "status of the campaign"
+    description: "Current status of the campaign"
+    example: "OPEN"
   created_at:
     type: string
     format: date-time
-    example: "2020-01-01T00:00:00Z"
-    description: "the date and time when the campaign was created"
+    readOnly: true
+    description: "When the campaign was created"
+    example: "2024-01-15T10:30:00Z"
   updated_at:
     type: string
     format: date-time
-    example: "2020-01-01T00:00:00Z"
-    description: "the date and time when the campaign was updated"
+    readOnly: true
+    description: "When the campaign was last updated"
+    example: "2024-01-15T10:30:00Z"

swt_api_spec/components/schemas/campaign.yaml

@@ -1,39 +1,72 @@
-#the campaign stock object to be stored
 type: object
+required:
+  - campaign_id
+  - product_name
+  - quantity
+  - unit
+  - stock_date
+  - unit_price
 properties:
   id:
     type: string
-    description: the unique identifier of a specific campaign stock
     format: cuid
     readOnly: true
+    description: "The unique ID of the stock entry"
+    example: "clh1234567890abcdef"
+  campaign_id:
+    type: string
+    format: cuid
+    description: "The ID of the campaign this stock belongs to"
+    example: "clh1234567890abcdef"
+  product_name:
+    type: string
+    description: "Name of the product"
+    example: "Premium Cocoa Beans"
   quantity:
     type: number
-    description: the quantity stored as not sold for a specific campaign.
-    format: int32
-  weight:
+    minimum: 0
+    description: "Quantity of product in stock"
+    example: 1000
+  unit:
     type: string
-    description: the weight use to mesure the stock
-    format: int32
-    example: 5kg
-  campaign_id:
+    description: "Unit of measurement"
+    example: "kg"
+  stock_date:
     type: string
-    format: cuid
-    description: the identifier of the campaign
-  company_id:
-    description: the companies ID to which the stock belongs to.
+    format: date
+    description: "Date when the stock was recorded"
+    example: "2024-01-15"
+  unit_price:
+    type: number
+    minimum: 0
+    description: "Price per unit"
+    example: 2.50
+  total_value:
+    type: number
+    minimum: 0
+    description: "Total value of the stock"
+    example: 2500.00
+  location:
     type: string
-    format: cuid
-    example: "AQA9CNo0cXNLt6sZp5Uc5P0"
-  unit_of_mesure:
-    description: The unit used to mesure the stock
-    type: integer
-    format: int32
-    example: 5 Ton, 5kg
+    description: "Storage location"
+    example: "Warehouse A"
+  condition:
+    type: string
+    description: "Condition of the stock"
+    example: "excellent"
+  notes:
+    type: string
+    description: "Additional notes about the stock"
+    example: "High-quality beans from organic farms"
   created_at:
     type: string
     format: date-time
-    description: the date and time when the stock was created
+    readOnly: true
+    description: "When the stock entry was created"
+    example: "2024-01-15T10:30:00Z"
   updated_at:
     type: string
     format: date-time
-    description: the date and time when the stock was updated
+    readOnly: true
+    description: "When the stock entry was last updated"
+    example: "2024-01-15T10:30:00Z"