feat(api): add invalidStatus and providerError response helpers
Some checks are pending
CI / PHP 8.2 (push) Waiting to run
CI / PHP 8.3 (push) Waiting to run
CI / PHP 8.4 (push) Waiting to run
CI / Assets (push) Waiting to run

Add two new response methods to HasApiResponses trait:
- invalidStatusResponse(): for operations blocked by resource status
- providerErrorResponse(): for external provider failures

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Snider 2026-01-29 21:18:56 +00:00
parent 0371d42e34
commit 37717b3548

View file

@ -89,4 +89,36 @@ trait HasApiResponses
'errors' => $errors,
], 422);
}
/**
* Return an invalid status error response.
*
* Used when an operation cannot be performed due to the resource's current status.
*/
protected function invalidStatusResponse(string $message): JsonResponse
{
return response()->json([
'error' => 'invalid_status',
'message' => $message,
], 422);
}
/**
* Return a provider error response.
*
* Used when an external provider operation fails.
*/
protected function providerErrorResponse(string $message, ?string $provider = null): JsonResponse
{
$response = [
'error' => 'provider_error',
'message' => $message,
];
if ($provider !== null) {
$response['provider'] = $provider;
}
return response()->json($response, 400);
}
}