SRS-048: API Documentation Endpoint
Identifier
SRS-048
Software System
- API Gateway
- Orchestrator
Category
- Input and output, interfaces
- Maintenance
Description
To facilitate integration and troubleshooting, the software shall expose its API definition to authorized users. The system shall provide the machine-readable OpenAPI 3.1 specification file at a dedicated endpoint (e.g., /openapi.json
). Additionally, the system shall expose a user-friendly, interactive documentation interface at /docs
.
Derived from PRS
PRS-1V6
: Expose the device’s functionality through a versioned, network-accessible API