English

العربية

English

العربية

Appearance

Translated specifications ​

Not yet released

Translated specifications ships in a release after API-dex 3.1.0 and is not in the current product. The Changelog lists it under Unreleased.

The specification a producer uploads is the canonical OpenAPI document. A translation is a locale overlay: a separate document, one per language, that names locations in the specification and supplies the translated titles, summaries and descriptions for them. API-dex applies the overlay when someone reads the specification, using the language they selected in the portal.

  • Where no overlay exists for the selected language, API-dex serves the canonical specification.
  • Where an overlay exists but cannot be applied, API-dex still serves the canonical specification. A translation problem never blocks a reader.
  • An overlay is not a second copy of the specification. It changes only the locations it names; everything else stays exactly as uploaded.
  • Downloads follow the language on screen, so a translated download is a valid OpenAPI document that describes the same API.

Overlays belong to a specification version. A new version starts without translations, and API-dex refuses an upload that would silently drop a language that is already published.

Administrators choose which languages the portal offers in Settings. Those languages should match the locales producers publish overlays for, so that a reader cannot pick a language that has no translation.