language of error messages and other strings

gbv / paia

Specification of Patrons Account Information API (PAIA)

http://gbv.github.io/paia

15 stars 12 forks source link

language of error messages and other strings #32

Closed nichtich closed 9 years ago

nichtich commented 10 years ago

should be localized by the HTTP accept-language header or sent in a default language.

JonathanRowell commented 9 years ago

PAIA is an interface and not a GUI. All messages, as in HTTP, should be in English and the client should provide a translation.

nichtich commented 9 years ago

We should have a look at common error types (#33) before further decision.

nichtich commented 9 years ago

Possibly language dependent fields in PAIA are limited to:

doc.about textual description of the document
doc.error error message, for instance if a request was rejected
patron.name full name of the patron
patron.address freeform address of the patron
doc.storage Requested pickup location (but there is also doc.storageid)
fee.about textual information about the fee
fee.feetype textual description of the type of fee (may be renamed, see #44)
error_description Human-readable error description (in request errors)

nichtich commented 9 years ago

After thinking more about this I decided to refer to good old Content-Negotiation (PAIA 1.0.8): https://github.com/gbv/paia/commit/143f118f87bdf7f931d77aee50a6d43efbb06b43

@JonathanRowell Translations provided by clients are only possible based on identifiers such as the error field of request errors. We don't have such identifiers for document errors, so I opened #45