Skip to content

Commit 4e37bd7

Browse files
author
Phrase
committed
1 parent bdd8ee3 commit 4e37bd7

238 files changed

Lines changed: 349 additions & 277 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api/openapi.yaml‎

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -359,18 +359,52 @@ paths:
359359
x-accepts: application/json
360360
/formats:
361361
get:
362-
description: Get a handy list of all localization file formats supported in
363-
Phrase.
362+
description: |
363+
Returns all file formats that Phrase Strings supports. Use the api_name value
364+
from each format as the file_format parameter when uploading or downloading
365+
locale files. Not every format supports both directions: check the importable
366+
and exportable fields before using a format in a workflow. This endpoint does
367+
not require authentication and is not subject to rate limiting.
364368
operationId: formats/list
365369
responses:
366370
"200":
367371
content:
368372
application/json:
373+
examples:
374+
default:
375+
value:
376+
- name: Ruby/Rails YAML
377+
api_name: yml
378+
description: YAML file format for use with Ruby/Rails applications
379+
extension: yml
380+
default_encoding: UTF-8
381+
importable: true
382+
exportable: true
383+
default_file: ./config/locales/<locale_name>.yml
384+
renders_default_locale: false
385+
includes_locale_information: false
386+
- name: Simple JSON
387+
api_name: simple_json
388+
description: A flat key/value JSON format
389+
extension: json
390+
default_encoding: UTF-8
391+
importable: true
392+
exportable: true
393+
default_file: ./config/locales/<locale_name>.json
394+
renders_default_locale: false
395+
includes_locale_information: false
369396
schema:
370397
items:
371398
$ref: '#/components/schemas/format'
372399
type: array
373400
description: OK
401+
headers:
402+
X-Rate-Limit-Limit:
403+
$ref: '#/components/headers/X-Rate-Limit-Limit'
404+
X-Rate-Limit-Remaining:
405+
$ref: '#/components/headers/X-Rate-Limit-Remaining'
406+
X-Rate-Limit-Reset:
407+
$ref: '#/components/headers/X-Rate-Limit-Reset'
374408
"400":
375409
description: Bad request
376410
headers:
@@ -385,7 +419,9 @@ paths:
385419
- Formats
386420
x-code-samples:
387421
- lang: Curl
388-
source: curl "https://api.phrase.com/v2/formats"
422+
source: |-
423+
curl "https://api.phrase.com/v2/formats" \
424+
-u USERNAME_OR_ACCESS_TOKEN
389425
- lang: CLI v2
390426
source: |-
391427
phrase formats list \
@@ -34371,28 +34407,64 @@ components:
3437134407
exportable: true
3437234408
default_file: ./config/locales/<locale_name>.yml
3437334409
renders_default_locale: false
34374-
includes_locale_information: true
34410+
includes_locale_information: false
3437534411
properties:
3437634412
name:
34413+
description: Human-readable display name of the format.
34414+
example: Ruby/Rails YAML
3437734415
type: string
3437834416
api_name:
34417+
description: "Identifier used to reference this format in API requests,\
34418+
\ such as the file_format parameter on the uploads and downloads endpoints."
34419+
example: yml
3437934420
type: string
3438034421
description:
34422+
description: Human-readable summary of the format and its typical use case.
34423+
example: YAML file format for use with Ruby/Rails applications
3438134424
type: string
3438234425
extension:
34426+
description: Default file extension associated with this format.
34427+
example: yml
3438334428
type: string
3438434429
default_encoding:
34430+
description: Default character encoding used when reading or writing files
34431+
in this format.
34432+
example: UTF-8
3438534433
type: string
3438634434
importable:
34435+
description: Whether locale files can be imported using this format.
34436+
example: true
3438734437
type: boolean
3438834438
exportable:
34439+
description: Whether locale files can be exported using this format.
34440+
example: true
3438934441
type: boolean
3439034442
default_file:
34443+
description: Conventional file path pattern for this format. Contains locale_name
34444+
as a placeholder for the locale identifier.
34445+
example: ./config/locales/<locale_name>.yml
3439134446
type: string
3439234447
renders_default_locale:
34448+
description: "When true, exported files contain the default locale's content\
34449+
\ for any key that has no translation in the target locale."
34450+
example: false
3439334451
type: boolean
3439434452
includes_locale_information:
34453+
description: "When true, files in this format embed locale information so\
34454+
\ Phrase can detect the locale automatically on import."
34455+
example: false
3439534456
type: boolean
34457+
required:
34458+
- api_name
34459+
- default_encoding
34460+
- default_file
34461+
- description
34462+
- exportable
34463+
- extension
34464+
- importable
34465+
- includes_locale_information
34466+
- name
34467+
- renders_default_locale
3439634468
title: format
3439734469
type: object
3439834470
project:

‎docs/Format.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**name** | **String** | | [optional]
10-
**apiName** | **String** | | [optional]
11-
**description** | **String** | | [optional]
12-
**extension** | **String** | | [optional]
13-
**defaultEncoding** | **String** | | [optional]
14-
**importable** | **Boolean** | | [optional]
15-
**exportable** | **Boolean** | | [optional]
16-
**defaultFile** | **String** | | [optional]
17-
**rendersDefaultLocale** | **Boolean** | | [optional]
18-
**includesLocaleInformation** | **Boolean** | | [optional]
9+
**name** | **String** | Human-readable display name of the format. |
10+
**apiName** | **String** | Identifier used to reference this format in API requests, such as the file_format parameter on the uploads and downloads endpoints. |
11+
**description** | **String** | Human-readable summary of the format and its typical use case. |
12+
**extension** | **String** | Default file extension associated with this format. |
13+
**defaultEncoding** | **String** | Default character encoding used when reading or writing files in this format. |
14+
**importable** | **Boolean** | Whether locale files can be imported using this format. |
15+
**exportable** | **Boolean** | Whether locale files can be exported using this format. |
16+
**defaultFile** | **String** | Conventional file path pattern for this format. Contains locale_name as a placeholder for the locale identifier. |
17+
**rendersDefaultLocale** | **Boolean** | When true, exported files contain the default locale&#39;s content for any key that has no translation in the target locale. |
18+
**includesLocaleInformation** | **Boolean** | When true, files in this format embed locale information so Phrase can detect the locale automatically on import. |
1919

2020

2121

‎docs/FormatsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313
1414
List formats
1515

16-
Get a handy list of all localization file formats supported in Phrase.
16+
Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.
1717

1818
### Example
1919
```java
@@ -74,6 +74,6 @@ This endpoint does not need any parameter.
7474
### HTTP response details
7575
| Status code | Description | Response headers |
7676
|-------------|-------------|------------------|
77-
**200** | OK | - |
77+
**200** | OK | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
7878
**400** | Bad request | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> |
7979

‎src/main/java/com/phrase/client/ApiException.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
import java.util.Map;
1616
import java.util.List;
1717

18-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T12:22:03.402782462Z[Etc/UTC]")
18+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T13:13:40.976226726Z[Etc/UTC]")
1919
public class ApiException extends Exception {
2020
private int code = 0;
2121
private Map<String, List<String>> responseHeaders = null;

‎src/main/java/com/phrase/client/Configuration.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
package com.phrase.client;
1414

15-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T12:22:03.402782462Z[Etc/UTC]")
15+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T13:13:40.976226726Z[Etc/UTC]")
1616
public class Configuration {
1717
private static ApiClient defaultApiClient = new ApiClient();
1818

‎src/main/java/com/phrase/client/Pair.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
package com.phrase.client;
1414

15-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T12:22:03.402782462Z[Etc/UTC]")
15+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T13:13:40.976226726Z[Etc/UTC]")
1616
public class Pair {
1717
private String name = "";
1818
private String value = "";

‎src/main/java/com/phrase/client/StringUtil.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
package com.phrase.client;
1414

15-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T12:22:03.402782462Z[Etc/UTC]")
15+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T13:13:40.976226726Z[Etc/UTC]")
1616
public class StringUtil {
1717
/**
1818
* Check if the given array contains the given value (with case-insensitive comparison).

‎src/main/java/com/phrase/client/api/FormatsApi.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public void setApiClient(ApiClient apiClient) {
6161
* @http.response.details
6262
<table summary="Response Details" border="1">
6363
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
64-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
64+
<tr><td> 200 </td><td> OK </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
6565
<tr><td> 400 </td><td> Bad request </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
6666
</table>
6767
*/
@@ -105,13 +105,13 @@ private okhttp3.Call formatsListValidateBeforeCall(final ApiCallback _callback)
105105

106106
/**
107107
* List formats
108-
* Get a handy list of all localization file formats supported in Phrase.
108+
* Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.
109109
* @return List&lt;Format&gt;
110110
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
111111
* @http.response.details
112112
<table summary="Response Details" border="1">
113113
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
114-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
114+
<tr><td> 200 </td><td> OK </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
115115
<tr><td> 400 </td><td> Bad request </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
116116
</table>
117117
*/
@@ -122,13 +122,13 @@ public List<Format> formatsList() throws ApiException {
122122

123123
/**
124124
* List formats
125-
* Get a handy list of all localization file formats supported in Phrase.
125+
* Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.
126126
* @return ApiResponse&lt;List&lt;Format&gt;&gt;
127127
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
128128
* @http.response.details
129129
<table summary="Response Details" border="1">
130130
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
131-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
131+
<tr><td> 200 </td><td> OK </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
132132
<tr><td> 400 </td><td> Bad request </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
133133
</table>
134134
*/
@@ -140,14 +140,14 @@ public ApiResponse<List<Format>> formatsListWithHttpInfo() throws ApiException {
140140

141141
/**
142142
* List formats (asynchronously)
143-
* Get a handy list of all localization file formats supported in Phrase.
143+
* Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.
144144
* @param _callback The callback to be executed when the API call finishes
145145
* @return The request call
146146
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
147147
* @http.response.details
148148
<table summary="Response Details" border="1">
149149
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
150-
<tr><td> 200 </td><td> OK </td><td> - </td></tr>
150+
<tr><td> 200 </td><td> OK </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
151151
<tr><td> 400 </td><td> Bad request </td><td> * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> </td></tr>
152152
</table>
153153
*/

‎src/main/java/com/phrase/client/auth/ApiKeyAuth.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.List;
1919

20-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T12:22:03.402782462Z[Etc/UTC]")
20+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T13:13:40.976226726Z[Etc/UTC]")
2121
public class ApiKeyAuth implements Authentication {
2222
private final String location;
2323
private final String paramName;

‎src/main/java/com/phrase/client/auth/HttpBearerAuth.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.List;
1919

20-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T12:22:03.402782462Z[Etc/UTC]")
20+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-06-17T13:13:40.976226726Z[Etc/UTC]")
2121
public class HttpBearerAuth implements Authentication {
2222
private final String scheme;
2323
private String bearerToken;

0 commit comments

Comments
 (0)