search

worldia / textmaster-api

Simple PHP client for the Textmaster API
1 stars 5 forks source link

Documentation clarification #81

Open cdaguerre opened 8 years ago

cdaguerre commented 8 years ago

@aponsin Could you please clarify the difference between these routes:

Please note that according to documentantion, the route public/countries/ doesnt require a locale although it should be public/countries/{locale} (Refer https://fr.textmaster.com/documentation#public-listing-localized-country-names)

/cc @jmleroux

aponsin commented 8 years ago

We are talking about different things here:

The 2 locales end point are essentially the same. But please usr /public/locales the other one is still there fore backward compatibility reasons only. But they essentially return the same data (almost).

The countries end point does not make the locale mandatory, it will default on the English names if not specified. But if you want to specify a locale you can, in order to get the name of the countries in French, or German, etc.

Finally the Abilities end point is really only there to let one know what "abilities" (read combination of Activity, Level and Language Pair) are currently available on the platform and their associated cost.

I hope this helps.