diff --git a/docs/frontend-api-contracts.md b/docs/frontend-api-contracts.md new file mode 100644 index 0000000..ba1f27f --- /dev/null +++ b/docs/frontend-api-contracts.md @@ -0,0 +1,33 @@ +# Frontend API Contracts + +Contracts are defined in `src/api/contracts`. + +Every service returns: + +```json +{ + "data": {}, + "meta": { + "requestId": "req_..." + }, + "error": null +} +``` + +Errors return: + +```json +{ + "data": null, + "meta": { + "requestId": "req_..." + }, + "error": { + "code": "VALIDATION_ERROR", + "message": "Human-readable message", + "fields": {} + } +} +``` + +Shared DTOs cover pagination, filtering, sorting, bulk operations, jobs, job progress, audit metadata, permission checks, and WebSocket events.