Multilingual support
See original GitHub issueHi there,
I’m wondering if there currently is any way to define language-specific values for the descriptive elements in the specification, such as description
, or example
?
For example:
{
"title": "Sample Pet Store App",
"description": "This is a sample server for a pet store.",
"version": "1.0.1"
}
Might be rewritten to:
{
"title": "Sample Pet Store App",
"description": {
"*": "This is a sample server for a pet store.",
"fr": "Ceci est un exemple de serveur pour une animalerie.",
},
"version": "1.0.1"
}
Where title
is a string, so it will be used as the text for all languages, while description
is an object consisting of language codes that code generators can use for additional language options (in this example, the * is used as a default wildcard).
Does something like this exist?
Issue Analytics
- State:
- Created 5 years ago
- Reactions:20
- Comments:8 (1 by maintainers)
Top Results From Across the Web
Multilingual Support - Mitel
Multilingual support extends the customer support experience to people who don't speak English, or who are more comfortable conversing in another language.
Read more >The Ins and Outs of Multilingual Customer Support | Phrase
Multilingual support is customer support that a business provides in multiple languages as part of the overall customer experience.
Read more >Multilingual Customer Support: What Is It and Why Do I Need It?
Multilingual customer support means making sure that all of your customers, regardless of their native or preferred language, culture or ...
Read more >Multilingual Support: Speak Your Customer's Language
Multilingual support allows brands to serve customers in more than one language. There are around 7,100 languages spoken in the world today.
Read more >What is Multilingual Support and How It Can Boost your ...
How a multilingual support help desk will improve your customer support documentation and boost your business into the global market.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Multilingual support in public documentation is almost certain required by many public policies. Maintaining multiple copies of OpenAPI YAML in different language is chaotic. It’d be a huge life saver to support multiple languages in OpenAPI.
Thanks!
Additional previous discussion: #274. Localization, internationalization or multilingual support, whatever you call it, is a must for products aiming to document something. Overlays may be overkill, and something better integrated with the specification is probably better.
It might be enough to support what was suggested in the original post: anywhere a string is supported, support an object where the keys are the language code, and the values are the translation.