Skip to content
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

Support localized problem detail messages #124

Open
jpraet opened this issue Oct 21, 2024 · 2 comments · May be fixed by #133
Open

Support localized problem detail messages #124

jpraet opened this issue Oct 21, 2024 · 2 comments · May be fixed by #133

Comments

@jpraet
Copy link
Contributor

jpraet commented Oct 21, 2024

The problem RFC 9457 allows for localized problem title and detail.
Belgif guidelines state the problem title should be in English (why?).

The requested language can be specified in an Accept-Language HTTP request header (see https://www.belgif.be/specification/rest/api-guide/#i18n-negotiation).

The rest-problem-java library could support localized problem (and issue) detail messages.
@jpraet
Copy link
Contributor Author

jpraet commented Oct 21, 2024

@pvdbosch do you know why the Belgif guidelines require the problem title to be in English, while the RFC 9457 does allow for it to be localized?

If that restriction is kept, maybe it should be added to the "This guide applies following additional restrictions on the Problem Details structure:" section.

@pvdbosch
Copy link
Contributor

The reason was that the problem title is meant for technical support people. They don't necessarily use the same language as the end user, and it's probably more beneficial to have a single recognizable message then.

The schema provides a bit more explanation: Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).

@jpraet jpraet linked a pull request Nov 4, 2024 that will close this issue
Open
jpraet added a commit that referenced this issue Nov 5, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
4b3a1c1
jpraet added a commit that referenced this issue Nov 6, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
ec89168
jpraet added a commit that referenced this issue Nov 19, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
4508118
jpraet added a commit that referenced this issue Nov 28, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
07b96a1
jflabatBCSS added a commit that referenced this issue Nov 29, 2024
@jflabatBCSS
Merge remote-tracking branch 'origin/feature/#124-i18n' into feature/#…
1a091fa 
…124-i18n
jpraet added a commit that referenced this issue Dec 6, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
a8103be
jpraet added a commit that referenced this issue Dec 9, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
28ab016
jpraet added a commit that referenced this issue Dec 11, 2024
@jpraet
Merge branch 'main' into feature/#124-i18n
58c298f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add internationalization support belgif/rest-problem-java
2 participants
@jpraet @pvdbosch