Skip to content

Commit cee058f

Browse files
Restructure OpenAPI/Swagger documentation into modular files
Split monolithic swagger spec into organized modular structure: - 14 schema files by domain (system, users, cellular, sms, network, etc.) - 14 path files by domain with full endpoint definitions - Main api-documentation.yaml with $ref imports - Generated bundled YAML and JSON files (271KB) - All schemas extracted from source .schema.json files - Validated with swagger-cli Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 9f8e49c commit cee058f

33 files changed

Lines changed: 28638 additions & 0 deletions

mpower-api-docs/SCHEMA-ANALYSIS-WORKING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,49 @@ This document tracks the progress of extracting accurate API schema information
252252

253253
---
254254

255+
## OpenAPI/Swagger Documentation
256+
257+
**Status:** ✅ Complete (February 10, 2026)
258+
259+
The OpenAPI specification has been restructured into modular files:
260+
261+
### Directory Structure
262+
```
263+
mpower-api-docs/openapi/
264+
├── api-documentation.yaml # Main spec with $ref imports
265+
├── schemas/ # 14 schema files by domain
266+
└── paths/ # 14 path files by domain
267+
```
268+
269+
### Generated Files
270+
- `api-documentation-bundled.yaml` - Bundled single-file YAML
271+
- `api-documentation-bundled.json` - Bundled single-file JSON (271 KB)
272+
273+
### Validation
274+
- ✅ Validated with swagger-cli
275+
- All schemas extracted from source `.schema.json` files
276+
- Covers 100+ endpoints across 58+ resources
277+
278+
### Schema Files
279+
| File | Contents |
280+
|------|----------|
281+
| common.yaml | Auth, responses, common types |
282+
| system.yaml | System configuration |
283+
| users.yaml | User management, roles, password rules |
284+
| cellular.yaml | Cellular, SIM profiles, backoff timers |
285+
| sms.yaml | SMS configuration and commands |
286+
| network.yaml | WiFi, DNS, DHCP, routes, WAN, DDNS |
287+
| vpn.yaml | OpenVPN, IPsec, GRE tunnels |
288+
| firewall.yaml | Firewall, filters, NAT, trusted IP |
289+
| lora.yaml | LoRa network server and devices |
290+
| services.yaml | SNMP, NTP, SMTP, syslog, LLDP, mDNS, RADIUS |
291+
| device-management.yaml | Auto reboot, remote access, Docker, apps |
292+
| connectivity.yaml | Bluetooth, BLE, GPS, serial, IP pipes |
293+
| advanced.yaml | SCADA, MQTT, alerts, I/O |
294+
| status.yaml | Status, event log, policy |
295+
296+
---
297+
255298
## Notes
256299

257300
### Data Sources Priority

0 commit comments

Comments
 (0)