New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Anti-pattern: APIs must not have user-facing translation #1318

Open

sldblog opened this issue Nov 18, 2022 · 0 comments

Labels

Contributor

sldblog commented Nov 18, 2022 •

edited

Loading

APIs must not be tied to specific wording for a particular type of user.

hmpps-interventions-service/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsinterventionsservice/exception/CommunityApiCallError.kt

Lines 38 to 39 in 86b8516

    
           category.contains("Contact type .* requires an outcome type as the contact date is in the past".toRegex()) -> { 
        
             "Delius requires an appointment to only be made for today or in the future. Please amend and try again"

Avoid: human-readable error messages from API

Do: error values, e.g. past_appointments_must_be_made_with_attendance and translation to be done by the client.

The text was updated successfully, but these errors were encountered:

sldblog added the code-smell label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment