Skip to main content

Beacon Tower v4.3.0 - API Gateway Core

Beacon Tower Team
Beacon Tower Team
Beacon Tower Developer Team

Release Period: March 11, 2025 - August 5, 2025 Versions: 0.1.185 → 0.1.205 (20 releases) Release Frequency: ~1 release per week

Major API Gateway upgrade with 360+ new routes for firmware deployment management, device simulations, and organization templates. Includes Ocelot 24.0.0 upgrade and critical data type fixes.

Beacon Tower v4.3.0 Release Notes

This release note covers the API Gateway Core component. View other v4.3.0 components:

Overview​

This release series introduces major new capabilities for firmware deployment management, device simulations, and organization template management. The API Gateway has been upgraded to Ocelot 24.0.0, and over 360 new routes have been added to support expanded IoT device management functionality.

⚠️ Breaking Changes​

Critical Breaking Change

This change requires immediate action from API consumers. Please review carefully.

Data Type Change: enabled Field (v0.1.195)​

Data Type Correction

The enabled flag has been corrected from string to boolean type.

Previous:

{
  "enabled": "true"
}

Current:

{
  "enabled": true
}

Impact: API clients expecting string values will receive validation errors

Action Required:

  • Update client code to use boolean values (true/false) instead of strings ("true"/"false")
  • Regenerate client SDKs if using auto-generated code
  • Update API integration tests

✨ New Features​

🚀 Deployment & Release Management System (v0.1.187 - v0.1.193)​

A comprehensive firmware deployment and release management system has been added, providing full lifecycle management for IoT device firmware updates.

New Capabilities:

  • Release Management: Create, update, and track firmware releases
  • Deployment Orchestration: Deploy firmware to device fleets with scheduling and rollout control
  • Deployment Templates: Define reusable deployment configurations
  • Method Templates: Configure deployment methods (e.g., OTA, manual, staged)
  • Status Tracking: Monitor deployment progress and status in real-time
  • Patch Operations: Apply targeted updates to existing deployments

API Endpoints Added:

  • Release endpoints for version management
  • Deployment endpoints for orchestration
  • Deployment template CRUD operations
  • Deployment status and monitoring endpoints
  • Method template configuration endpoints

Use Cases:

  • Scheduled firmware rollouts across device fleets
  • Phased deployment strategies (canary, blue-green)
  • Automated rollback capabilities
  • Multi-tenant deployment isolation
View API Reference

Explore the complete API specification at /api for detailed endpoint documentation.

🖥️ Device Simulations API (v0.1.194)​

Complete API for device simulation and testing, enabling developers to test IoT workflows without physical hardware.

Capabilities:

  • Create and manage virtual device simulations
  • Configure simulated device behaviors
  • Test data processing pipelines
  • Validate firmware deployment workflows
  • Multi-tenant simulation isolation

Benefits:

  • Faster development cycles
  • Reduced hardware dependencies for testing
  • Ability to simulate edge cases and error conditions
  • Load testing with virtual device fleets

🔄 Provider Client Firmware Update Management (v0.1.198 - v0.1.204)​

Enhanced firmware update management for provider clients with full lifecycle control.

New Capabilities:

  • Cancel Operations: Abort in-progress firmware updates (v0.1.198)
  • Status Monitoring: Real-time firmware update status tracking (v0.1.198)
  • Cleanup Operations: Delete firmware update records (v0.1.204)

API Endpoints:

  • POST /provider-client/firmware-update/cancel - Cancel active updates
  • GET /provider-client/firmware-update/status - Query update status
  • DELETE /provider-client/firmware-update/{id} - Remove update records

🏢 Organization Templates API (v0.1.187)​

Complete API for managing organization templates to support multi-tenant configuration and onboarding.

Capabilities:

  • Create organization templates with predefined configurations
  • Apply templates during tenant onboarding
  • Update template definitions
  • Query and list available templates
  • Multi-tenant isolation for template management

Use Cases:

  • Standardized tenant onboarding
  • Industry-specific configuration presets
  • Role and permission templates
  • Device type configurations

📁 Resource File Re-upload (v0.1.200)​

New capability to re-upload resource files without creating new resource entries.

Benefits:

  • Update resource files while maintaining resource IDs
  • Preserve references and relationships
  • Version control for resource content
  • Improved resource lifecycle management

🔧 API Improvements​

Response Schema Corrections​

Resource Endpoints (v0.1.186):

  • Fixed CreateResource endpoint response schema
  • Corrected UploadResource endpoint response format
  • Improved consistency across resource operations

Asset Binding (v0.1.205):

  • Corrected asset bind response object structure
  • Fixed schema validation for asset relationships

Provider Clients (v0.1.196):

  • Fixed schema error in getProviderClients documentation
  • Improved response type definitions

Gateway Configuration Updates​

Firmware Endpoints (v0.1.197):

  • Adjusted routing for firmware management endpoints
  • Improved request forwarding and path mapping

Multiple Configuration Fixes:

  • Corrected provider client firmware update routing (v0.1.199, v0.1.201, v0.1.203)
  • Fixed deployment restart route configuration (v0.1.191)
  • Resolved OpenAPI specification errors (v0.1.202)

🐛 Bug Fixes​

API Gateway Routing​

  • Fixed typo in PC FWU cancel endpoint configuration (v0.1.203)
  • Corrected OpenAPI spec error for PC FWU cancel operation (v0.1.202)
  • Resolved deployment restart route misconfiguration (v0.1.191)
  • General ocelot.json configuration fixes (v0.1.199, v0.1.201)

API Documentation​

  • Fixed schema validation errors in provider clients documentation (v0.1.196)
  • Corrected response object definitions for asset binding (v0.1.205)
  • Updated resource endpoint response schemas (v0.1.186)

🏗️ Technical Updates​

Infrastructure​

  • Ocelot Framework: Upgraded to version 24.0.0 (v0.1.194)
  • API Routes: Added 360+ new gateway routes
  • OpenAPI Specification: 5,364 lines added, 2,629 lines modified

Architecture​

  • Enhanced multi-tenant data isolation patterns
  • Improved firmware deployment orchestration
  • Expanded device simulation capabilities
  • Strengthened organization template management

📋 Migration Guide​

For API Consumers​

  1. Test Breaking Changes:

    • Verify enabled field type changes in your API requests/responses
    • Test all endpoints after Ocelot 24.0.0 upgrade

  2. Update Client Libraries:

    • Regenerate client SDKs from updated OpenAPI specification
    • Update type definitions for enabled field (string → boolean)

  3. Review New Capabilities:

    • Evaluate deployment management features for firmware update workflows
    • Consider using simulations API for testing and development
    • Review organization templates for tenant onboarding automation

  4. Update Integration Tests:

    • Add tests for new deployment and simulation endpoints
    • Update tests for corrected response schemas
    • Validate boolean type handling for enabled fields

🔗 Resources​

  • OpenAPI Specification: View API Reference
  • Support: Contact your Beacon Tower support representative

📝 Next Steps​

  1. Review breaking changes and plan migration timeline
  2. Update client applications and SDKs
  3. Test integration with new deployment management features
  4. Explore simulations API for development and testing workflows
  5. Consider organization templates for tenant onboarding automation

For detailed technical information or questions about specific features, please contact the Beacon Tower development team.