SRS-046: Standard HTTP Status Code Usage
Identifierβ
SRS-046
Software Systemβ
- API Gateway
- Orchestrator
Categoryβ
- Input and output, interfaces
- Alarms, warnings, and messages
Descriptionβ
The software shall use standard HTTP status codes to communicate the outcome of an API request. This provides a standardized, machine-readable mechanism for clients to handle request outcomes. This includes, but is not limited to:
- 2xx for successful requests (e.g.,
200 OK
). - 4xx for client-side errors (e.g.,
400 Bad Request
,401 Unauthorized
,404 Not Found
,422 Unprocessable Entity
). - 5xx for server-side errors (e.g.,
500 Internal Server Error
).
Derived from PRSβ
PRS-1V6
: Expose the deviceβs functionality through a versioned, network-accessible API