Standardize on Responses

[human058382928]

Make sure that the responses are standardized. Right now some return in a wrapper like

{"status": "success", "data": object } 

and some are just the

object

We just need one way to do them all. I would say do them all wrapped that way incase we need to do pagination you can add that metadata in the wrapper like .

{"status": "success", "page": 1, "total": 500, "data": object}

Technically i don't need the status field that can be determined through http codes.

[human058382928]

If its not a 200 then we can standardize on body always being

{"error": "somemessagehere"}

[whoabuddy]

This was the template I used while updating each endpoint, should all be fixed in #34 now

---

1. Successful Responses (Status Codes 200-299)

When Returning Data

createApiResponse({
	message: 'A clear description of what succeeded',
	data: { theActualData },
});

When Returning Message Only

createApiResponse({
	message: 'A clear description of what succeeded',
});

2. Error Responses (Status Codes 300+)

Use a direct string message:

createApiResponse('A clear description of what went wrong', errorStatusCode);

3. Specific Patterns

• Always include a descriptive message for successful operations
• Keep error messages concise and descriptive
• Use consistent status codes for similar types of errors
• Data should be structured as an object when including additional information

4. Implementation Examples

Success with Data

return createApiResponse({
	message: 'Successfully retrieved crews',
	data: { crews },
});

Success with Message Only

return createApiResponse({
	message: `Successfully deleted ${key}`,
});

Error Response

return createApiResponse('Missing required parameter: address', 400);

Example Responses

Example Success Response:

{
	"success": true,
	"message": "Successfully retrieved crews",
	"data": { "object with data" }
}

Example Success Response (Message Only):

{
	"success": true,
	"message": "Successfully deleted crew"
}

Example Error Response:

{
	"success": false,
	"error": "Missing required parameter: address"
}