Skip to content

Commit 3d1be33

Browse files
author
Phrase
committed
1 parent 473f904 commit 3d1be33

251 files changed

Lines changed: 273 additions & 267 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: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15371,6 +15371,8 @@ paths:
1537115371
description: |
1537215372
Upload a new language file. Creates necessary resources in your project.
1537315373

15374+
The upload is processed asynchronously: this endpoint returns `201 Created` once the file has been accepted and enqueued, not once processing has finished. Poll `GET /projects/{project_id}/uploads/{id}` and check the `state` field — `error` means processing failed (for example, an unparseable file or a `file_format` that doesn't match the file's actual content).
15375+
1537415376
Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
1537515377
operationId: upload/create
1537615378
parameters:
@@ -15486,7 +15488,6 @@ paths:
1548615488
-X POST \
1548715489
-F branch=my-feature-branch \
1548815490
-F file=@/path/to/my/file.json \
15489-
-F file_format=json \
1549015491
-F locale_id=abcd1234cdef1234abcd1234cdef1234 \
1549115492
-F tags=awesome-feature,needs-proofreading \
1549215493
-F locale_mapping[en]=2 \
@@ -15497,7 +15498,6 @@ paths:
1549715498
--project_id <project_id> \
1549815499
--branch my-feature-branch \
1549915500
--file /path/to/my/file.json \
15500-
--file_format json \
1550115501
--locale_id abcd1234cdef1234abcd1234cdef1234 \
1550215502
--tags awesome-feature,needs-proofreading \
1550315503
--locale_mapping '{"en": "2"}' \
@@ -15508,7 +15508,8 @@ paths:
1550815508
x-accepts: application/json
1550915509
/projects/{project_id}/uploads/{id}:
1551015510
get:
15511-
description: View details and summary for a single upload.
15511+
description: |
15512+
View details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via `POST /projects/{project_id}/uploads` — check the `state` field.
1551215513
operationId: upload/show
1551315514
parameters:
1551415515
- description: Two-Factor-Authentication token (optional)
@@ -39467,6 +39468,8 @@ components:
3946739468
format:
3946839469
type: string
3946939470
state:
39471+
description: |
39472+
Processing state of the upload: `initialized`, `processing`, `success`, or `error`. `error` means processing failed — for example the file could not be parsed, or a provided `file_format` didn't match the file's actual content. Poll this field until it leaves `initialized`/`processing` to get the final outcome.
3947039473
type: string
3947139474
error_message:
3947239475
description: |
@@ -43366,7 +43369,10 @@ components:
4336643369
format: binary
4336743370
type: string
4336843371
file_format:
43369-
description: File format. Auto-detected when possible and not specified.
43372+
description: |
43373+
File format of the uploaded file, given as a format's `api_name`. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats.
43374+
43375+
Optional. When omitted, Phrase tries to auto-detect the format from the file's content. This is not always possible for JSON files, since several JSON-based formats (e.g. `json`, `simple_json`, `nested_json`) share the same structure.
4337043376
example: json
4337143377
type: string
4337243378
locale_id:

‎docs/Upload.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**id** | **String** | | [optional]
1010
**filename** | **String** | | [optional]
1111
**format** | **String** | | [optional]
12-
**state** | **String** | | [optional]
12+
**state** | **String** | Processing state of the upload: &#x60;initialized&#x60;, &#x60;processing&#x60;, &#x60;success&#x60;, or &#x60;error&#x60;. &#x60;error&#x60; means processing failed — for example the file could not be parsed, or a provided &#x60;file_format&#x60; didn&#39;t match the file&#39;s actual content. Poll this field until it leaves &#x60;initialized&#x60;/&#x60;processing&#x60; to get the final outcome. | [optional]
1313
**errorMessage** | **String** | A user-facing message explaining why the upload failed, or &#x60;null&#x60; if the upload did not fail. This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically. | [optional]
1414
**tag** | **String** | Unique tag of the upload | [optional]
1515
**tags** | **List&lt;String&gt;** | List of tags that were assigned to the uploaded keys | [optional]

‎docs/UploadsApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Method | HTTP request | Description
1515
1616
Upload a new file
1717

18-
Upload a new language file. Creates necessary resources in your project. Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
18+
Upload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns &#x60;201 Created&#x60; once the file has been accepted and enqueued, not once processing has finished. Poll &#x60;GET /projects/{project_id}/uploads/{id}&#x60; and check the &#x60;state&#x60; field — &#x60;error&#x60; means processing failed (for example, an unparseable file or a &#x60;file_format&#x60; that doesn&#39;t match the file&#39;s actual content). Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
1919

2020
### Example
2121
```java
@@ -45,7 +45,7 @@ public class Example {
4545
UploadsApi apiInstance = new UploadsApi(defaultClient);
4646
String projectId = "projectId_example"; // String | Project ID
4747
File _file = new File("/path/to/file"); // File | File to be imported
48-
String fileFormat = "fileFormat_example"; // String | File format. Auto-detected when possible and not specified.
48+
String fileFormat = "fileFormat_example"; // String | File format of the uploaded file, given as a format's `api_name`. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file's content. This is not always possible for JSON files, since several JSON-based formats (e.g. `json`, `simple_json`, `nested_json`) share the same structure.
4949
String localeId = "localeId_example"; // String | Locale of the file's content. Can be the name or id of the locale. Preferred is id.
5050
String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
5151
String branch = "branch_example"; // String | specify the branch to use
@@ -88,7 +88,7 @@ Name | Type | Description | Notes
8888
------------- | ------------- | ------------- | -------------
8989
**projectId** | **String**| Project ID |
9090
**_file** | **File**| File to be imported |
91-
**fileFormat** | **String**| File format. Auto-detected when possible and not specified. |
91+
**fileFormat** | **String**| File format of the uploaded file, given as a format&#39;s &#x60;api_name&#x60;. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file&#39;s content. This is not always possible for JSON files, since several JSON-based formats (e.g. &#x60;json&#x60;, &#x60;simple_json&#x60;, &#x60;nested_json&#x60;) share the same structure. |
9292
**localeId** | **String**| Locale of the file&#39;s content. Can be the name or id of the locale. Preferred is id. |
9393
**xPhraseAppOTP** | **String**| Two-Factor-Authentication token (optional) | [optional]
9494
**branch** | **String**| specify the branch to use | [optional]
@@ -142,7 +142,7 @@ Name | Type | Description | Notes
142142
143143
Get a single upload
144144

145-
View details and summary for a single upload.
145+
View details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via &#x60;POST /projects/{project_id}/uploads&#x60; — check the &#x60;state&#x60; field.
146146

147147
### Example
148148
```java

‎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-09-11T11:11:06.552180239Z[Etc/UTC]")
18+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-09-11T12:31:16.760733738Z[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-09-11T11:11:06.552180239Z[Etc/UTC]")
15+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-09-11T12:31:16.760733738Z[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-09-11T11:11:06.552180239Z[Etc/UTC]")
15+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-09-11T12:31:16.760733738Z[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-09-11T11:11:06.552180239Z[Etc/UTC]")
15+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-09-11T12:31:16.760733738Z[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/UploadsApi.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public void setApiClient(ApiClient apiClient) {
5959
* Build call for uploadCreate
6060
* @param projectId Project ID (required)
6161
* @param _file File to be imported (required)
62-
* @param fileFormat File format. Auto-detected when possible and not specified. (required)
62+
* @param fileFormat File format of the uploaded file, given as a format&#39;s &#x60;api_name&#x60;. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file&#39;s content. This is not always possible for JSON files, since several JSON-based formats (e.g. &#x60;json&#x60;, &#x60;simple_json&#x60;, &#x60;nested_json&#x60;) share the same structure. (required)
6363
* @param localeId Locale of the file&#39;s content. Can be the name or id of the locale. Preferred is id. (required)
6464
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
6565
* @param branch specify the branch to use (optional)
@@ -254,10 +254,10 @@ private okhttp3.Call uploadCreateValidateBeforeCall(String projectId, File _file
254254

255255
/**
256256
* Upload a new file
257-
* Upload a new language file. Creates necessary resources in your project. Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
257+
* Upload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns &#x60;201 Created&#x60; once the file has been accepted and enqueued, not once processing has finished. Poll &#x60;GET /projects/{project_id}/uploads/{id}&#x60; and check the &#x60;state&#x60; field — &#x60;error&#x60; means processing failed (for example, an unparseable file or a &#x60;file_format&#x60; that doesn&#39;t match the file&#39;s actual content). Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
258258
* @param projectId Project ID (required)
259259
* @param _file File to be imported (required)
260-
* @param fileFormat File format. Auto-detected when possible and not specified. (required)
260+
* @param fileFormat File format of the uploaded file, given as a format&#39;s &#x60;api_name&#x60;. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file&#39;s content. This is not always possible for JSON files, since several JSON-based formats (e.g. &#x60;json&#x60;, &#x60;simple_json&#x60;, &#x60;nested_json&#x60;) share the same structure. (required)
261261
* @param localeId Locale of the file&#39;s content. Can be the name or id of the locale. Preferred is id. (required)
262262
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
263263
* @param branch specify the branch to use (optional)
@@ -301,10 +301,10 @@ public Upload uploadCreate(String projectId, File _file, String fileFormat, Stri
301301

302302
/**
303303
* Upload a new file
304-
* Upload a new language file. Creates necessary resources in your project. Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
304+
* Upload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns &#x60;201 Created&#x60; once the file has been accepted and enqueued, not once processing has finished. Poll &#x60;GET /projects/{project_id}/uploads/{id}&#x60; and check the &#x60;state&#x60; field — &#x60;error&#x60; means processing failed (for example, an unparseable file or a &#x60;file_format&#x60; that doesn&#39;t match the file&#39;s actual content). Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
305305
* @param projectId Project ID (required)
306306
* @param _file File to be imported (required)
307-
* @param fileFormat File format. Auto-detected when possible and not specified. (required)
307+
* @param fileFormat File format of the uploaded file, given as a format&#39;s &#x60;api_name&#x60;. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file&#39;s content. This is not always possible for JSON files, since several JSON-based formats (e.g. &#x60;json&#x60;, &#x60;simple_json&#x60;, &#x60;nested_json&#x60;) share the same structure. (required)
308308
* @param localeId Locale of the file&#39;s content. Can be the name or id of the locale. Preferred is id. (required)
309309
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
310310
* @param branch specify the branch to use (optional)
@@ -349,10 +349,10 @@ public ApiResponse<Upload> uploadCreateWithHttpInfo(String projectId, File _file
349349

350350
/**
351351
* Upload a new file (asynchronously)
352-
* Upload a new language file. Creates necessary resources in your project. Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
352+
* Upload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns &#x60;201 Created&#x60; once the file has been accepted and enqueued, not once processing has finished. Poll &#x60;GET /projects/{project_id}/uploads/{id}&#x60; and check the &#x60;state&#x60; field — &#x60;error&#x60; means processing failed (for example, an unparseable file or a &#x60;file_format&#x60; that doesn&#39;t match the file&#39;s actual content). Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0).
353353
* @param projectId Project ID (required)
354354
* @param _file File to be imported (required)
355-
* @param fileFormat File format. Auto-detected when possible and not specified. (required)
355+
* @param fileFormat File format of the uploaded file, given as a format&#39;s &#x60;api_name&#x60;. See our [Formats API Endpoint](/en/api/strings/formats/list-formats) for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file&#39;s content. This is not always possible for JSON files, since several JSON-based formats (e.g. &#x60;json&#x60;, &#x60;simple_json&#x60;, &#x60;nested_json&#x60;) share the same structure. (required)
356356
* @param localeId Locale of the file&#39;s content. Can be the name or id of the locale. Preferred is id. (required)
357357
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
358358
* @param branch specify the branch to use (optional)
@@ -477,7 +477,7 @@ private okhttp3.Call uploadShowValidateBeforeCall(String projectId, String id, S
477477

478478
/**
479479
* Get a single upload
480-
* View details and summary for a single upload.
480+
* View details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via &#x60;POST /projects/{project_id}/uploads&#x60; — check the &#x60;state&#x60; field.
481481
* @param projectId Project ID (required)
482482
* @param id ID (required)
483483
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
@@ -502,7 +502,7 @@ public Upload uploadShow(String projectId, String id, String xPhraseAppOTP, Stri
502502

503503
/**
504504
* Get a single upload
505-
* View details and summary for a single upload.
505+
* View details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via &#x60;POST /projects/{project_id}/uploads&#x60; — check the &#x60;state&#x60; field.
506506
* @param projectId Project ID (required)
507507
* @param id ID (required)
508508
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)
@@ -528,7 +528,7 @@ public ApiResponse<Upload> uploadShowWithHttpInfo(String projectId, String id, S
528528

529529
/**
530530
* Get a single upload (asynchronously)
531-
* View details and summary for a single upload.
531+
* View details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via &#x60;POST /projects/{project_id}/uploads&#x60; — check the &#x60;state&#x60; field.
532532
* @param projectId Project ID (required)
533533
* @param id ID (required)
534534
* @param xPhraseAppOTP Two-Factor-Authentication token (optional) (optional)

‎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-09-11T11:11:06.552180239Z[Etc/UTC]")
20+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-09-11T12:31:16.760733738Z[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-09-11T11:11:06.552180239Z[Etc/UTC]")
20+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2026-09-11T12:31:16.760733738Z[Etc/UTC]")
2121
public class HttpBearerAuth implements Authentication {
2222
private final String scheme;
2323
private String bearerToken;

0 commit comments

Comments
 (0)