@@ -1633,13 +1633,30 @@ paths:
16331633 500:
16341634 $ref: '#/components/responses/Error500ResponseDefinition'
16351635
1636- /files-api/v2/projects/{projectId}/locales/{localeId }/file:
1636+ /files-api/v2/projects/{projectId}/locales/{localeIds }/file:
16371637 get:
1638- summary: Download translated file (single locale)
1638+ summary: Download translated file (single locale or multi-locale )
16391639 tags:
16401640 - Files
16411641 description: |
1642- This downloads the requested file from Smartling.
1642+ Downloads the requested translated file from Smartling.
1643+
1644+ This endpoint supports two modes depending on the value of `localeIds`:
1645+
1646+ ### **Single-locale mode**
1647+ - Provide a **single locale ID**, e.g. `fr-FR`
1648+ - Smartling returns a file containing translations only for that locale
1649+ - Supported for **all file types**.
1650+
1651+ ### **Multi-locale mode**
1652+ - Provide a **comma-separated list of locale IDs**, e.g. `fr-FR,de-DE,es-ES`
1653+ - Or specify `all` to include all available locales
1654+ - Smartling returns a **combined multi-locale file** with translations for all specified locales inside one file
1655+ - Supported only for:
1656+ **MADCAP, DITA_ZIP, CSV, XLSX_TEMPLATE, XCSTRINGS**
1657+
1658+
1659+ ---
16431660
16441661 It is important to check the HTTP response status code. If Smartling
16451662 finds and returns the file normally, you will receive a `200` SUCCESS
@@ -1657,8 +1674,8 @@ paths:
16571674 associated with the requested file. In most cases, the filename is
16581675 exactly the fileUri provided. The only exception to this is with .pot
16591676 gettext files. When a .pot file is specified as the fileUri, Smartling
1660- returns a .po file.`
1661- operationId: downloadTranslatedFileSingleLocale
1677+ returns a .po file.
1678+ operationId: downloadTranslatedFile
16621679
16631680 parameters:
16641681 - name: projectId
@@ -1667,8 +1684,13 @@ paths:
16671684 required: true
16681685 schema:
16691686 type: string
1670- - name: localeId
1671- description: Identifier for a locale.
1687+
1688+ - name: localeIds
1689+ description: |
1690+ One of:
1691+ - A **single locale ID**, e.g. `"fr-FR"` → single-locale mode
1692+ - A **comma-separated list** of locale IDs, e.g. `"fr-FR,de-DE"` → multi-locale mode
1693+ - `"all"` → download translations for all available locales
16721694 in: path
16731695 required: true
16741696 schema:
@@ -1753,7 +1775,7 @@ paths:
17531775
17541776 When you upload a UTF-16 character encoded file, then /file/get requests
17551777 for that file will have a character encoding of UTF-16. All other
1756- uploaded files will return with a character encoding of UTF-8.
1778+ uploaded files will be returned with a character encoding of UTF-8.
17571779
17581780 You can always use the content-type header in the response of a file/get
17591781 request to determine the character encoding.
0 commit comments