Translated specifications
The specification you upload is the canonical OpenAPI document. Locale views are locale overlays: separate patch documents applied when someone reads the spec, using the language they chose in the portal.
- If no overlay exists for that language, the portal serves the canonical spec.
- If an overlay exists but cannot be applied, the portal still serves the canonical spec and shows a warning so you know you are not seeing the translated view.
- Overlays are not a second copy of the whole spec. They only change the targets they name; everything else stays as uploaded.
Administrators choose which languages the portal offers in Settings. Those languages should match the locales you publish overlays for — otherwise visitors can pick a language that has no translation.
This is not the same as overlaying the Platform Management API for documentation publishing. Here the overlay describes your product spec for a visitor language.
Related topics
- Exposing your API — attach overlays when you publish
- Consuming an API — read a spec in your language
- Reference — locale overlays — document shape, locales, and API behaviour
- Reference — settings — which languages the portal offers