refactor: standardise error response format across API controllers #20

New issue

Open

opened 2026-02-20 16:38:32 +00:00 by Clotho · 0 comments

Clotho commented

2026-02-20 16:38:32 +00:00

Member

Problem

Error response formats vary between Controllers/EntitlementApiController.php and Controllers/Api/EntitlementWebhookController.php. Some return {"error": "msg"}, others {"success": false, "message": "msg"}.

Standard to adopt

{
  "success": false,
  "error": "Human-readable message",
  "code": "MACHINE_READABLE_CODE"
}

Acceptance Criteria

Create an ApiResponseTrait or use existing HasApiResponses consistently
Apply uniform error format to all API controllers in this package
Document response format in README.md or docs/
Update integration tests to assert the standardised format

Discovered during automated scan (issue #3)

## Problem Error response formats vary between `Controllers/EntitlementApiController.php` and `Controllers/Api/EntitlementWebhookController.php`. Some return `{"error": "msg"}`, others `{"success": false, "message": "msg"}`. ## Standard to adopt ```json { "success": false, "error": "Human-readable message", "code": "MACHINE_READABLE_CODE" } ``` ## Acceptance Criteria - Create an `ApiResponseTrait` or use existing `HasApiResponses` consistently - Apply uniform error format to all API controllers in this package - Document response format in `README.md` or `docs/` - Update integration tests to assert the standardised format _Discovered during automated scan (issue #3)_